spotted 0.23.0 → 0.25.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.
Files changed (192) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/spotted/internal/type/base_model.rb +1 -0
  5. data/lib/spotted/models/album_bulk_retrieve_response.rb +26 -2
  6. data/lib/spotted/models/album_restriction_object.rb +13 -1
  7. data/lib/spotted/models/album_retrieve_response.rb +26 -2
  8. data/lib/spotted/models/artist_list_albums_response.rb +13 -1
  9. data/lib/spotted/models/artist_object.rb +13 -1
  10. data/lib/spotted/models/audio_analysis_retrieve_response.rb +39 -3
  11. data/lib/spotted/models/audio_feature_bulk_retrieve_response.rb +13 -1
  12. data/lib/spotted/models/audio_feature_retrieve_response.rb +13 -1
  13. data/lib/spotted/models/audiobook_base.rb +13 -1
  14. data/lib/spotted/models/audiobook_bulk_retrieve_response.rb +13 -1
  15. data/lib/spotted/models/audiobook_retrieve_response.rb +13 -1
  16. data/lib/spotted/models/author_object.rb +13 -1
  17. data/lib/spotted/models/browse/category_get_playlists_response.rb +13 -1
  18. data/lib/spotted/models/browse/category_list_response.rb +26 -2
  19. data/lib/spotted/models/browse/category_retrieve_response.rb +13 -1
  20. data/lib/spotted/models/browse_get_featured_playlists_response.rb +13 -1
  21. data/lib/spotted/models/browse_get_new_releases_response.rb +26 -2
  22. data/lib/spotted/models/chapter_bulk_retrieve_response.rb +13 -1
  23. data/lib/spotted/models/chapter_restriction_object.rb +13 -1
  24. data/lib/spotted/models/chapter_retrieve_response.rb +13 -1
  25. data/lib/spotted/models/copyright_object.rb +13 -1
  26. data/lib/spotted/models/episode_object.rb +13 -1
  27. data/lib/spotted/models/episode_restriction_object.rb +13 -1
  28. data/lib/spotted/models/external_id_object.rb +13 -1
  29. data/lib/spotted/models/external_url_object.rb +13 -1
  30. data/lib/spotted/models/followers_object.rb +13 -1
  31. data/lib/spotted/models/image_object.rb +13 -1
  32. data/lib/spotted/models/linked_track_object.rb +13 -1
  33. data/lib/spotted/models/me/album_list_response.rb +39 -3
  34. data/lib/spotted/models/me/audiobook_list_response.rb +26 -2
  35. data/lib/spotted/models/me/context_object.rb +13 -1
  36. data/lib/spotted/models/me/device_object.rb +13 -1
  37. data/lib/spotted/models/me/episode_list_response.rb +13 -1
  38. data/lib/spotted/models/me/following_bulk_retrieve_response.rb +30 -2
  39. data/lib/spotted/models/me/player/queue_get_response.rb +16 -1
  40. data/lib/spotted/models/me/player_get_currently_playing_response.rb +30 -2
  41. data/lib/spotted/models/me/player_get_state_response.rb +29 -2
  42. data/lib/spotted/models/me/player_list_recently_played_response.rb +16 -1
  43. data/lib/spotted/models/me/show_list_response.rb +13 -1
  44. data/lib/spotted/models/me/track_list_response.rb +13 -1
  45. data/lib/spotted/models/me_retrieve_response.rb +26 -2
  46. data/lib/spotted/models/narrator_object.rb +13 -1
  47. data/lib/spotted/models/paging_playlist_object.rb +13 -1
  48. data/lib/spotted/models/playlist_retrieve_response.rb +21 -8
  49. data/lib/spotted/models/playlist_track_object.rb +13 -1
  50. data/lib/spotted/models/playlist_tracks_ref_object.rb +13 -1
  51. data/lib/spotted/models/playlist_user_object.rb +13 -1
  52. data/lib/spotted/models/recommendation_get_response.rb +26 -2
  53. data/lib/spotted/models/resume_point_object.rb +13 -1
  54. data/lib/spotted/models/search_query_response.rb +91 -7
  55. data/lib/spotted/models/show_base.rb +13 -1
  56. data/lib/spotted/models/show_retrieve_response.rb +13 -1
  57. data/lib/spotted/models/simplified_artist_object.rb +13 -1
  58. data/lib/spotted/models/simplified_chapter_object.rb +13 -1
  59. data/lib/spotted/models/simplified_episode_object.rb +13 -1
  60. data/lib/spotted/models/simplified_playlist_object.rb +8 -7
  61. data/lib/spotted/models/simplified_track_object.rb +13 -1
  62. data/lib/spotted/models/time_interval_object.rb +16 -1
  63. data/lib/spotted/models/track_object.rb +26 -2
  64. data/lib/spotted/models/track_restriction_object.rb +13 -1
  65. data/lib/spotted/models/user_retrieve_profile_response.rb +13 -1
  66. data/lib/spotted/models/users/playlist_create_response.rb +21 -8
  67. data/lib/spotted/version.rb +1 -1
  68. data/rbi/spotted/models/album_bulk_retrieve_response.rbi +41 -3
  69. data/rbi/spotted/models/album_restriction_object.rbi +22 -1
  70. data/rbi/spotted/models/album_retrieve_response.rbi +41 -3
  71. data/rbi/spotted/models/artist_list_albums_response.rbi +19 -0
  72. data/rbi/spotted/models/artist_object.rbi +19 -0
  73. data/rbi/spotted/models/audio_analysis_retrieve_response.rbi +57 -0
  74. data/rbi/spotted/models/audio_feature_bulk_retrieve_response.rbi +19 -0
  75. data/rbi/spotted/models/audio_feature_retrieve_response.rbi +19 -0
  76. data/rbi/spotted/models/audiobook_base.rbi +20 -1
  77. data/rbi/spotted/models/audiobook_bulk_retrieve_response.rbi +22 -3
  78. data/rbi/spotted/models/audiobook_retrieve_response.rbi +22 -3
  79. data/rbi/spotted/models/author_object.rbi +22 -3
  80. data/rbi/spotted/models/browse/category_get_playlists_response.rbi +25 -3
  81. data/rbi/spotted/models/browse/category_list_response.rbi +44 -6
  82. data/rbi/spotted/models/browse/category_retrieve_response.rbi +22 -3
  83. data/rbi/spotted/models/browse_get_featured_playlists_response.rbi +25 -3
  84. data/rbi/spotted/models/browse_get_new_releases_response.rbi +41 -3
  85. data/rbi/spotted/models/chapter_bulk_retrieve_response.rbi +19 -0
  86. data/rbi/spotted/models/chapter_restriction_object.rbi +21 -2
  87. data/rbi/spotted/models/chapter_retrieve_response.rbi +19 -0
  88. data/rbi/spotted/models/copyright_object.rbi +25 -2
  89. data/rbi/spotted/models/episode_object.rbi +19 -0
  90. data/rbi/spotted/models/episode_restriction_object.rbi +21 -2
  91. data/rbi/spotted/models/external_id_object.rbi +28 -2
  92. data/rbi/spotted/models/external_url_object.rbi +21 -2
  93. data/rbi/spotted/models/followers_object.rbi +27 -4
  94. data/rbi/spotted/models/image_object.rbi +26 -3
  95. data/rbi/spotted/models/linked_track_object.rbi +19 -0
  96. data/rbi/spotted/models/me/album_list_response.rbi +63 -6
  97. data/rbi/spotted/models/me/audiobook_list_response.rbi +44 -6
  98. data/rbi/spotted/models/me/context_object.rbi +19 -0
  99. data/rbi/spotted/models/me/device_object.rbi +19 -0
  100. data/rbi/spotted/models/me/episode_list_response.rbi +27 -3
  101. data/rbi/spotted/models/me/following_bulk_retrieve_response.rbi +47 -3
  102. data/rbi/spotted/models/me/player/queue_get_response.rbi +19 -0
  103. data/rbi/spotted/models/me/player_get_currently_playing_response.rbi +38 -0
  104. data/rbi/spotted/models/me/player_get_state_response.rbi +38 -0
  105. data/rbi/spotted/models/me/player_list_recently_played_response.rbi +19 -0
  106. data/rbi/spotted/models/me/show_list_response.rbi +27 -4
  107. data/rbi/spotted/models/me/track_list_response.rbi +29 -4
  108. data/rbi/spotted/models/me_retrieve_response.rbi +47 -5
  109. data/rbi/spotted/models/narrator_object.rbi +22 -3
  110. data/rbi/spotted/models/paging_playlist_object.rbi +22 -3
  111. data/rbi/spotted/models/playlist_retrieve_response.rbi +36 -15
  112. data/rbi/spotted/models/playlist_track_object.rbi +19 -0
  113. data/rbi/spotted/models/playlist_tracks_ref_object.rbi +27 -2
  114. data/rbi/spotted/models/playlist_user_object.rbi +19 -0
  115. data/rbi/spotted/models/recommendation_get_response.rbi +41 -3
  116. data/rbi/spotted/models/resume_point_object.rbi +27 -4
  117. data/rbi/spotted/models/search_query_response.rbi +151 -18
  118. data/rbi/spotted/models/show_base.rbi +20 -1
  119. data/rbi/spotted/models/show_retrieve_response.rbi +22 -3
  120. data/rbi/spotted/models/simplified_artist_object.rbi +19 -0
  121. data/rbi/spotted/models/simplified_chapter_object.rbi +19 -0
  122. data/rbi/spotted/models/simplified_episode_object.rbi +19 -0
  123. data/rbi/spotted/models/simplified_playlist_object.rbi +14 -12
  124. data/rbi/spotted/models/simplified_track_object.rbi +19 -0
  125. data/rbi/spotted/models/time_interval_object.rbi +31 -4
  126. data/rbi/spotted/models/track_object.rbi +38 -0
  127. data/rbi/spotted/models/track_restriction_object.rbi +21 -2
  128. data/rbi/spotted/models/user_retrieve_profile_response.rbi +19 -0
  129. data/rbi/spotted/models/users/playlist_create_response.rbi +36 -15
  130. data/sig/spotted/models/album_bulk_retrieve_response.rbs +17 -3
  131. data/sig/spotted/models/album_restriction_object.rbs +10 -1
  132. data/sig/spotted/models/album_retrieve_response.rbs +17 -3
  133. data/sig/spotted/models/artist_list_albums_response.rbs +7 -0
  134. data/sig/spotted/models/artist_object.rbs +7 -0
  135. data/sig/spotted/models/audio_analysis_retrieve_response.rbs +21 -0
  136. data/sig/spotted/models/audio_feature_bulk_retrieve_response.rbs +7 -0
  137. data/sig/spotted/models/audio_feature_retrieve_response.rbs +7 -0
  138. data/sig/spotted/models/audiobook_base.rbs +9 -2
  139. data/sig/spotted/models/audiobook_bulk_retrieve_response.rbs +10 -3
  140. data/sig/spotted/models/audiobook_retrieve_response.rbs +10 -3
  141. data/sig/spotted/models/author_object.rbs +7 -3
  142. data/sig/spotted/models/browse/category_get_playlists_response.rbs +13 -3
  143. data/sig/spotted/models/browse/category_list_response.rbs +20 -6
  144. data/sig/spotted/models/browse/category_retrieve_response.rbs +10 -3
  145. data/sig/spotted/models/browse_get_featured_playlists_response.rbs +13 -3
  146. data/sig/spotted/models/browse_get_new_releases_response.rbs +17 -3
  147. data/sig/spotted/models/chapter_bulk_retrieve_response.rbs +7 -0
  148. data/sig/spotted/models/chapter_restriction_object.rbs +7 -3
  149. data/sig/spotted/models/chapter_retrieve_response.rbs +7 -0
  150. data/sig/spotted/models/copyright_object.rbs +7 -3
  151. data/sig/spotted/models/episode_object.rbs +7 -0
  152. data/sig/spotted/models/episode_restriction_object.rbs +7 -3
  153. data/sig/spotted/models/external_id_object.rbs +19 -4
  154. data/sig/spotted/models/external_url_object.rbs +7 -3
  155. data/sig/spotted/models/followers_object.rbs +11 -3
  156. data/sig/spotted/models/image_object.rbs +18 -3
  157. data/sig/spotted/models/linked_track_object.rbs +7 -0
  158. data/sig/spotted/models/me/album_list_response.rbs +30 -6
  159. data/sig/spotted/models/me/audiobook_list_response.rbs +20 -6
  160. data/sig/spotted/models/me/context_object.rbs +7 -0
  161. data/sig/spotted/models/me/device_object.rbs +7 -0
  162. data/sig/spotted/models/me/episode_list_response.rbs +12 -3
  163. data/sig/spotted/models/me/following_bulk_retrieve_response.rbs +18 -3
  164. data/sig/spotted/models/me/player/queue_get_response.rbs +7 -0
  165. data/sig/spotted/models/me/player_get_currently_playing_response.rbs +14 -0
  166. data/sig/spotted/models/me/player_get_state_response.rbs +14 -0
  167. data/sig/spotted/models/me/player_list_recently_played_response.rbs +7 -0
  168. data/sig/spotted/models/me/show_list_response.rbs +16 -3
  169. data/sig/spotted/models/me/track_list_response.rbs +16 -3
  170. data/sig/spotted/models/me_retrieve_response.rbs +23 -3
  171. data/sig/spotted/models/narrator_object.rbs +7 -3
  172. data/sig/spotted/models/paging_playlist_object.rbs +10 -3
  173. data/sig/spotted/models/playlist_retrieve_response.rbs +15 -8
  174. data/sig/spotted/models/playlist_track_object.rbs +7 -0
  175. data/sig/spotted/models/playlist_tracks_ref_object.rbs +8 -3
  176. data/sig/spotted/models/playlist_user_object.rbs +7 -0
  177. data/sig/spotted/models/recommendation_get_response.rbs +17 -3
  178. data/sig/spotted/models/resume_point_object.rbs +11 -2
  179. data/sig/spotted/models/search_query_response.rbs +67 -18
  180. data/sig/spotted/models/show_base.rbs +9 -2
  181. data/sig/spotted/models/show_retrieve_response.rbs +10 -3
  182. data/sig/spotted/models/simplified_artist_object.rbs +7 -0
  183. data/sig/spotted/models/simplified_chapter_object.rbs +7 -0
  184. data/sig/spotted/models/simplified_episode_object.rbs +7 -0
  185. data/sig/spotted/models/simplified_playlist_object.rbs +5 -5
  186. data/sig/spotted/models/simplified_track_object.rbs +7 -0
  187. data/sig/spotted/models/time_interval_object.rbs +12 -2
  188. data/sig/spotted/models/track_object.rbs +14 -0
  189. data/sig/spotted/models/track_restriction_object.rbs +7 -3
  190. data/sig/spotted/models/user_retrieve_profile_response.rbs +7 -0
  191. data/sig/spotted/models/users/playlist_create_response.rbs +15 -8
  192. metadata +2 -2
@@ -16,6 +16,16 @@ module Spotted
16
16
  # @return [String, nil]
17
17
  optional :href, String
18
18
 
19
+ # @!attribute published
20
+ # The playlist's public/private status (if it should be added to the user's
21
+ # profile or not): `true` the playlist will be public, `false` the playlist will
22
+ # be private, `null` the playlist status is not relevant. For more about
23
+ # public/private status, see
24
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
25
+ #
26
+ # @return [Boolean, nil]
27
+ optional :published, Spotted::Internal::Type::Boolean
28
+
19
29
  # @!attribute type
20
30
  # The object type, e.g. "artist", "playlist", "album", "show".
21
31
  #
@@ -29,7 +39,7 @@ module Spotted
29
39
  # @return [String, nil]
30
40
  optional :uri, String
31
41
 
32
- # @!method initialize(external_urls: nil, href: nil, type: nil, uri: nil)
42
+ # @!method initialize(external_urls: nil, href: nil, published: nil, type: nil, uri: nil)
33
43
  # Some parameter documentations has been truncated, see
34
44
  # {Spotted::Models::Me::ContextObject} for more details.
35
45
  #
@@ -37,6 +47,8 @@ module Spotted
37
47
  #
38
48
  # @param href [String] A link to the Web API endpoint providing full details of the track.
39
49
  #
50
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
51
+ #
40
52
  # @param type [String] The object type, e.g. "artist", "playlist", "album", "show".
41
53
  #
42
54
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the cont
@@ -39,6 +39,16 @@ module Spotted
39
39
  # @return [String, nil]
40
40
  optional :name, String
41
41
 
42
+ # @!attribute published
43
+ # The playlist's public/private status (if it should be added to the user's
44
+ # profile or not): `true` the playlist will be public, `false` the playlist will
45
+ # be private, `null` the playlist status is not relevant. For more about
46
+ # public/private status, see
47
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
48
+ #
49
+ # @return [Boolean, nil]
50
+ optional :published, Spotted::Internal::Type::Boolean
51
+
42
52
  # @!attribute supports_volume
43
53
  # If this device can be used to set the volume.
44
54
  #
@@ -57,7 +67,7 @@ module Spotted
57
67
  # @return [Integer, nil]
58
68
  optional :volume_percent, Integer, nil?: true
59
69
 
60
- # @!method initialize(id: nil, is_active: nil, is_private_session: nil, is_restricted: nil, name: nil, supports_volume: nil, type: nil, volume_percent: nil)
70
+ # @!method initialize(id: nil, is_active: nil, is_private_session: nil, is_restricted: nil, name: nil, published: nil, supports_volume: nil, type: nil, volume_percent: nil)
61
71
  # Some parameter documentations has been truncated, see
62
72
  # {Spotted::Models::Me::DeviceObject} for more details.
63
73
  #
@@ -71,6 +81,8 @@ module Spotted
71
81
  #
72
82
  # @param name [String] A human-readable name for the device. Some devices have a name that the user can
73
83
  #
84
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
85
+ #
74
86
  # @param supports_volume [Boolean] If this device can be used to set the volume.
75
87
  #
76
88
  # @param type [String] Device type, such as "computer", "smartphone" or "speaker".
@@ -19,13 +19,25 @@ module Spotted
19
19
  # @return [Spotted::Models::EpisodeObject, nil]
20
20
  optional :episode, -> { Spotted::EpisodeObject }
21
21
 
22
- # @!method initialize(added_at: nil, episode: nil)
22
+ # @!attribute published
23
+ # The playlist's public/private status (if it should be added to the user's
24
+ # profile or not): `true` the playlist will be public, `false` the playlist will
25
+ # be private, `null` the playlist status is not relevant. For more about
26
+ # public/private status, see
27
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
28
+ #
29
+ # @return [Boolean, nil]
30
+ optional :published, Spotted::Internal::Type::Boolean
31
+
32
+ # @!method initialize(added_at: nil, episode: nil, published: nil)
23
33
  # Some parameter documentations has been truncated, see
24
34
  # {Spotted::Models::Me::EpisodeListResponse} for more details.
25
35
  #
26
36
  # @param added_at [Time] The date and time the episode was saved.
27
37
  #
28
38
  # @param episode [Spotted::Models::EpisodeObject] Information about the episode.
39
+ #
40
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
29
41
  end
30
42
  end
31
43
  end
@@ -44,13 +44,23 @@ module Spotted
44
44
  # @return [String, nil]
45
45
  optional :next_, String, api_name: :next
46
46
 
47
+ # @!attribute published
48
+ # The playlist's public/private status (if it should be added to the user's
49
+ # profile or not): `true` the playlist will be public, `false` the playlist will
50
+ # be private, `null` the playlist status is not relevant. For more about
51
+ # public/private status, see
52
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
53
+ #
54
+ # @return [Boolean, nil]
55
+ optional :published, Spotted::Internal::Type::Boolean
56
+
47
57
  # @!attribute total
48
58
  # The total number of items available to return.
49
59
  #
50
60
  # @return [Integer, nil]
51
61
  optional :total, Integer
52
62
 
53
- # @!method initialize(cursors: nil, href: nil, items: nil, limit: nil, next_: nil, total: nil)
63
+ # @!method initialize(cursors: nil, href: nil, items: nil, limit: nil, next_: nil, published: nil, total: nil)
54
64
  # Some parameter documentations has been truncated, see
55
65
  # {Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists} for more details.
56
66
  #
@@ -64,6 +74,8 @@ module Spotted
64
74
  #
65
75
  # @param next_ [String] URL to the next page of items. ( `null` if none)
66
76
  #
77
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
78
+ #
67
79
  # @param total [Integer] The total number of items available to return.
68
80
 
69
81
  # @see Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists#cursors
@@ -80,12 +92,28 @@ module Spotted
80
92
  # @return [String, nil]
81
93
  optional :before, String
82
94
 
83
- # @!method initialize(after: nil, before: nil)
95
+ # @!attribute published
96
+ # The playlist's public/private status (if it should be added to the user's
97
+ # profile or not): `true` the playlist will be public, `false` the playlist will
98
+ # be private, `null` the playlist status is not relevant. For more about
99
+ # public/private status, see
100
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
101
+ #
102
+ # @return [Boolean, nil]
103
+ optional :published, Spotted::Internal::Type::Boolean
104
+
105
+ # @!method initialize(after: nil, before: nil, published: nil)
106
+ # Some parameter documentations has been truncated, see
107
+ # {Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists::Cursors} for more
108
+ # details.
109
+ #
84
110
  # The cursors used to find the next set of items.
85
111
  #
86
112
  # @param after [String] The cursor to use as key to find the next page of items.
87
113
  #
88
114
  # @param before [String] The cursor to use as key to find the previous page of items.
115
+ #
116
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
89
117
  end
90
118
  end
91
119
  end
@@ -12,6 +12,16 @@ module Spotted
12
12
  # @return [Spotted::Models::TrackObject, Spotted::Models::EpisodeObject, nil]
13
13
  optional :currently_playing, union: -> { Spotted::Models::Me::Player::QueueGetResponse::CurrentlyPlaying }
14
14
 
15
+ # @!attribute published
16
+ # The playlist's public/private status (if it should be added to the user's
17
+ # profile or not): `true` the playlist will be public, `false` the playlist will
18
+ # be private, `null` the playlist status is not relevant. For more about
19
+ # public/private status, see
20
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
21
+ #
22
+ # @return [Boolean, nil]
23
+ optional :published, Spotted::Internal::Type::Boolean
24
+
15
25
  # @!attribute queue
16
26
  # The tracks or episodes in the queue. Can be empty.
17
27
  #
@@ -19,9 +29,14 @@ module Spotted
19
29
  optional :queue,
20
30
  -> { Spotted::Internal::Type::ArrayOf[union: Spotted::Models::Me::Player::QueueGetResponse::Queue] }
21
31
 
22
- # @!method initialize(currently_playing: nil, queue: nil)
32
+ # @!method initialize(currently_playing: nil, published: nil, queue: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {Spotted::Models::Me::Player::QueueGetResponse} for more details.
35
+ #
23
36
  # @param currently_playing [Spotted::Models::TrackObject, Spotted::Models::EpisodeObject] The currently playing track or episode. Can be `null`.
24
37
  #
38
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
39
+ #
25
40
  # @param queue [Array<Spotted::Models::TrackObject, Spotted::Models::EpisodeObject>] The tracks or episodes in the queue. Can be empty.
26
41
 
27
42
  # The currently playing track or episode. Can be `null`.
@@ -43,13 +43,23 @@ module Spotted
43
43
  # @return [Integer, nil]
44
44
  optional :progress_ms, Integer
45
45
 
46
+ # @!attribute published
47
+ # The playlist's public/private status (if it should be added to the user's
48
+ # profile or not): `true` the playlist will be public, `false` the playlist will
49
+ # be private, `null` the playlist status is not relevant. For more about
50
+ # public/private status, see
51
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
52
+ #
53
+ # @return [Boolean, nil]
54
+ optional :published, Spotted::Internal::Type::Boolean
55
+
46
56
  # @!attribute timestamp
47
57
  # Unix Millisecond Timestamp when data was fetched
48
58
  #
49
59
  # @return [Integer, nil]
50
60
  optional :timestamp, Integer
51
61
 
52
- # @!method initialize(actions: nil, context: nil, currently_playing_type: nil, is_playing: nil, item: nil, progress_ms: nil, timestamp: nil)
62
+ # @!method initialize(actions: nil, context: nil, currently_playing_type: nil, is_playing: nil, item: nil, progress_ms: nil, published: nil, timestamp: nil)
53
63
  # Some parameter documentations has been truncated, see
54
64
  # {Spotted::Models::Me::PlayerGetCurrentlyPlayingResponse} for more details.
55
65
  #
@@ -65,6 +75,8 @@ module Spotted
65
75
  #
66
76
  # @param progress_ms [Integer] Progress into the currently playing track or episode. Can be `null`.
67
77
  #
78
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
79
+ #
68
80
  # @param timestamp [Integer] Unix Millisecond Timestamp when data was fetched
69
81
 
70
82
  # @see Spotted::Models::Me::PlayerGetCurrentlyPlayingResponse#actions
@@ -81,6 +93,16 @@ module Spotted
81
93
  # @return [Boolean, nil]
82
94
  optional :pausing, Spotted::Internal::Type::Boolean
83
95
 
96
+ # @!attribute published
97
+ # The playlist's public/private status (if it should be added to the user's
98
+ # profile or not): `true` the playlist will be public, `false` the playlist will
99
+ # be private, `null` the playlist status is not relevant. For more about
100
+ # public/private status, see
101
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
102
+ #
103
+ # @return [Boolean, nil]
104
+ optional :published, Spotted::Internal::Type::Boolean
105
+
84
106
  # @!attribute resuming
85
107
  # Resuming. Optional field.
86
108
  #
@@ -129,7 +151,11 @@ module Spotted
129
151
  # @return [Boolean, nil]
130
152
  optional :transferring_playback, Spotted::Internal::Type::Boolean
131
153
 
132
- # @!method initialize(interrupting_playback: nil, pausing: nil, resuming: nil, seeking: nil, skipping_next: nil, skipping_prev: nil, toggling_repeat_context: nil, toggling_repeat_track: nil, toggling_shuffle: nil, transferring_playback: nil)
154
+ # @!method initialize(interrupting_playback: nil, pausing: nil, published: nil, resuming: nil, seeking: nil, skipping_next: nil, skipping_prev: nil, toggling_repeat_context: nil, toggling_repeat_track: nil, toggling_shuffle: nil, transferring_playback: nil)
155
+ # Some parameter documentations has been truncated, see
156
+ # {Spotted::Models::Me::PlayerGetCurrentlyPlayingResponse::Actions} for more
157
+ # details.
158
+ #
133
159
  # Allows to update the user interface based on which playback actions are
134
160
  # available within the current context.
135
161
  #
@@ -137,6 +163,8 @@ module Spotted
137
163
  #
138
164
  # @param pausing [Boolean] Pausing. Optional field.
139
165
  #
166
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
167
+ #
140
168
  # @param resuming [Boolean] Resuming. Optional field.
141
169
  #
142
170
  # @param seeking [Boolean] Seeking playback location. Optional field.
@@ -49,6 +49,16 @@ module Spotted
49
49
  # @return [Integer, nil]
50
50
  optional :progress_ms, Integer
51
51
 
52
+ # @!attribute published
53
+ # The playlist's public/private status (if it should be added to the user's
54
+ # profile or not): `true` the playlist will be public, `false` the playlist will
55
+ # be private, `null` the playlist status is not relevant. For more about
56
+ # public/private status, see
57
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
58
+ #
59
+ # @return [Boolean, nil]
60
+ optional :published, Spotted::Internal::Type::Boolean
61
+
52
62
  # @!attribute repeat_state
53
63
  # off, track, context
54
64
  #
@@ -68,7 +78,7 @@ module Spotted
68
78
  # @return [Integer, nil]
69
79
  optional :timestamp, Integer
70
80
 
71
- # @!method initialize(actions: nil, context: nil, currently_playing_type: nil, device: nil, is_playing: nil, item: nil, progress_ms: nil, repeat_state: nil, shuffle_state: nil, timestamp: nil)
81
+ # @!method initialize(actions: nil, context: nil, currently_playing_type: nil, device: nil, is_playing: nil, item: nil, progress_ms: nil, published: nil, repeat_state: nil, shuffle_state: nil, timestamp: nil)
72
82
  # Some parameter documentations has been truncated, see
73
83
  # {Spotted::Models::Me::PlayerGetStateResponse} for more details.
74
84
  #
@@ -86,6 +96,8 @@ module Spotted
86
96
  #
87
97
  # @param progress_ms [Integer] Progress into the currently playing track or episode. Can be `null`.
88
98
  #
99
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
100
+ #
89
101
  # @param repeat_state [String] off, track, context
90
102
  #
91
103
  # @param shuffle_state [Boolean] If shuffle is on or off.
@@ -106,6 +118,16 @@ module Spotted
106
118
  # @return [Boolean, nil]
107
119
  optional :pausing, Spotted::Internal::Type::Boolean
108
120
 
121
+ # @!attribute published
122
+ # The playlist's public/private status (if it should be added to the user's
123
+ # profile or not): `true` the playlist will be public, `false` the playlist will
124
+ # be private, `null` the playlist status is not relevant. For more about
125
+ # public/private status, see
126
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
127
+ #
128
+ # @return [Boolean, nil]
129
+ optional :published, Spotted::Internal::Type::Boolean
130
+
109
131
  # @!attribute resuming
110
132
  # Resuming. Optional field.
111
133
  #
@@ -154,7 +176,10 @@ module Spotted
154
176
  # @return [Boolean, nil]
155
177
  optional :transferring_playback, Spotted::Internal::Type::Boolean
156
178
 
157
- # @!method initialize(interrupting_playback: nil, pausing: nil, resuming: nil, seeking: nil, skipping_next: nil, skipping_prev: nil, toggling_repeat_context: nil, toggling_repeat_track: nil, toggling_shuffle: nil, transferring_playback: nil)
179
+ # @!method initialize(interrupting_playback: nil, pausing: nil, published: nil, resuming: nil, seeking: nil, skipping_next: nil, skipping_prev: nil, toggling_repeat_context: nil, toggling_repeat_track: nil, toggling_shuffle: nil, transferring_playback: nil)
180
+ # Some parameter documentations has been truncated, see
181
+ # {Spotted::Models::Me::PlayerGetStateResponse::Actions} for more details.
182
+ #
158
183
  # Allows to update the user interface based on which playback actions are
159
184
  # available within the current context.
160
185
  #
@@ -162,6 +187,8 @@ module Spotted
162
187
  #
163
188
  # @param pausing [Boolean] Pausing. Optional field.
164
189
  #
190
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
191
+ #
165
192
  # @param resuming [Boolean] Resuming. Optional field.
166
193
  #
167
194
  # @param seeking [Boolean] Seeking playback location. Optional field.
@@ -17,17 +17,32 @@ module Spotted
17
17
  # @return [Time, nil]
18
18
  optional :played_at, Time
19
19
 
20
+ # @!attribute published
21
+ # The playlist's public/private status (if it should be added to the user's
22
+ # profile or not): `true` the playlist will be public, `false` the playlist will
23
+ # be private, `null` the playlist status is not relevant. For more about
24
+ # public/private status, see
25
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
26
+ #
27
+ # @return [Boolean, nil]
28
+ optional :published, Spotted::Internal::Type::Boolean
29
+
20
30
  # @!attribute track
21
31
  # The track the user listened to.
22
32
  #
23
33
  # @return [Spotted::Models::TrackObject, nil]
24
34
  optional :track, -> { Spotted::TrackObject }
25
35
 
26
- # @!method initialize(context: nil, played_at: nil, track: nil)
36
+ # @!method initialize(context: nil, played_at: nil, published: nil, track: nil)
37
+ # Some parameter documentations has been truncated, see
38
+ # {Spotted::Models::Me::PlayerListRecentlyPlayedResponse} for more details.
39
+ #
27
40
  # @param context [Spotted::Models::Me::ContextObject] The context the track was played from.
28
41
  #
29
42
  # @param played_at [Time] The date and time the track was played.
30
43
  #
44
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
45
+ #
31
46
  # @param track [Spotted::Models::TrackObject] The track the user listened to.
32
47
  end
33
48
  end
@@ -15,18 +15,30 @@ module Spotted
15
15
  # @return [Time, nil]
16
16
  optional :added_at, Time
17
17
 
18
+ # @!attribute published
19
+ # The playlist's public/private status (if it should be added to the user's
20
+ # profile or not): `true` the playlist will be public, `false` the playlist will
21
+ # be private, `null` the playlist status is not relevant. For more about
22
+ # public/private status, see
23
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
24
+ #
25
+ # @return [Boolean, nil]
26
+ optional :published, Spotted::Internal::Type::Boolean
27
+
18
28
  # @!attribute show
19
29
  # Information about the show.
20
30
  #
21
31
  # @return [Spotted::Models::ShowBase, nil]
22
32
  optional :show, -> { Spotted::ShowBase }
23
33
 
24
- # @!method initialize(added_at: nil, show: nil)
34
+ # @!method initialize(added_at: nil, published: nil, show: nil)
25
35
  # Some parameter documentations has been truncated, see
26
36
  # {Spotted::Models::Me::ShowListResponse} for more details.
27
37
  #
28
38
  # @param added_at [Time] The date and time the show was saved.
29
39
  #
40
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
41
+ #
30
42
  # @param show [Spotted::Models::ShowBase] Information about the show.
31
43
  end
32
44
  end
@@ -15,18 +15,30 @@ module Spotted
15
15
  # @return [Time, nil]
16
16
  optional :added_at, Time
17
17
 
18
+ # @!attribute published
19
+ # The playlist's public/private status (if it should be added to the user's
20
+ # profile or not): `true` the playlist will be public, `false` the playlist will
21
+ # be private, `null` the playlist status is not relevant. For more about
22
+ # public/private status, see
23
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
24
+ #
25
+ # @return [Boolean, nil]
26
+ optional :published, Spotted::Internal::Type::Boolean
27
+
18
28
  # @!attribute track
19
29
  # Information about the track.
20
30
  #
21
31
  # @return [Spotted::Models::TrackObject, nil]
22
32
  optional :track, -> { Spotted::TrackObject }
23
33
 
24
- # @!method initialize(added_at: nil, track: nil)
34
+ # @!method initialize(added_at: nil, published: nil, track: nil)
25
35
  # Some parameter documentations has been truncated, see
26
36
  # {Spotted::Models::Me::TrackListResponse} for more details.
27
37
  #
28
38
  # @param added_at [Time] The date and time the track was saved.
29
39
  #
40
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
41
+ #
30
42
  # @param track [Spotted::Models::TrackObject] Information about the track.
31
43
  end
32
44
  end
@@ -81,6 +81,16 @@ module Spotted
81
81
  # @return [String, nil]
82
82
  optional :product, String
83
83
 
84
+ # @!attribute published
85
+ # The playlist's public/private status (if it should be added to the user's
86
+ # profile or not): `true` the playlist will be public, `false` the playlist will
87
+ # be private, `null` the playlist status is not relevant. For more about
88
+ # public/private status, see
89
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
90
+ #
91
+ # @return [Boolean, nil]
92
+ optional :published, Spotted::Internal::Type::Boolean
93
+
84
94
  # @!attribute type
85
95
  # The object type: "user"
86
96
  #
@@ -94,7 +104,7 @@ module Spotted
94
104
  # @return [String, nil]
95
105
  optional :uri, String
96
106
 
97
- # @!method initialize(id: nil, country: nil, display_name: nil, email: nil, explicit_content: nil, external_urls: nil, followers: nil, href: nil, images: nil, product: nil, type: nil, uri: nil)
107
+ # @!method initialize(id: nil, country: nil, display_name: nil, email: nil, explicit_content: nil, external_urls: nil, followers: nil, href: nil, images: nil, product: nil, published: nil, type: nil, uri: nil)
98
108
  # Some parameter documentations has been truncated, see
99
109
  # {Spotted::Models::MeRetrieveResponse} for more details.
100
110
  #
@@ -120,6 +130,8 @@ module Spotted
120
130
  #
121
131
  # @param product [String] The user's Spotify subscription level: "premium", "free", etc. (The subscription
122
132
  #
133
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
134
+ #
123
135
  # @param type [String] The object type: "user"
124
136
  #
125
137
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the user
@@ -139,7 +151,17 @@ module Spotted
139
151
  # @return [Boolean, nil]
140
152
  optional :filter_locked, Spotted::Internal::Type::Boolean
141
153
 
142
- # @!method initialize(filter_enabled: nil, filter_locked: nil)
154
+ # @!attribute published
155
+ # The playlist's public/private status (if it should be added to the user's
156
+ # profile or not): `true` the playlist will be public, `false` the playlist will
157
+ # be private, `null` the playlist status is not relevant. For more about
158
+ # public/private status, see
159
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
160
+ #
161
+ # @return [Boolean, nil]
162
+ optional :published, Spotted::Internal::Type::Boolean
163
+
164
+ # @!method initialize(filter_enabled: nil, filter_locked: nil, published: nil)
143
165
  # Some parameter documentations has been truncated, see
144
166
  # {Spotted::Models::MeRetrieveResponse::ExplicitContent} for more details.
145
167
  #
@@ -151,6 +173,8 @@ module Spotted
151
173
  # @param filter_enabled [Boolean] When `true`, indicates that explicit content should not be played.
152
174
  #
153
175
  # @param filter_locked [Boolean] When `true`, indicates that the explicit content setting is locked and can't be
176
+ #
177
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
154
178
  end
155
179
  end
156
180
  end
@@ -9,11 +9,23 @@ module Spotted
9
9
  # @return [String, nil]
10
10
  optional :name, String
11
11
 
12
- # @!method initialize(name: nil)
12
+ # @!attribute published
13
+ # The playlist's public/private status (if it should be added to the user's
14
+ # profile or not): `true` the playlist will be public, `false` the playlist will
15
+ # be private, `null` the playlist status is not relevant. For more about
16
+ # public/private status, see
17
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
18
+ #
19
+ # @return [Boolean, nil]
20
+ optional :published, Spotted::Internal::Type::Boolean
21
+
22
+ # @!method initialize(name: nil, published: nil)
13
23
  # Some parameter documentations has been truncated, see
14
24
  # {Spotted::Models::NarratorObject} for more details.
15
25
  #
16
26
  # @param name [String] The name of the Narrator.
27
+ #
28
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
17
29
  end
18
30
  end
19
31
  end
@@ -44,7 +44,17 @@ module Spotted
44
44
  # @return [Array<Spotted::Models::SimplifiedPlaylistObject>, nil]
45
45
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedPlaylistObject] }
46
46
 
47
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
47
+ # @!attribute published
48
+ # The playlist's public/private status (if it should be added to the user's
49
+ # profile or not): `true` the playlist will be public, `false` the playlist will
50
+ # be private, `null` the playlist status is not relevant. For more about
51
+ # public/private status, see
52
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
53
+ #
54
+ # @return [Boolean, nil]
55
+ optional :published, Spotted::Internal::Type::Boolean
56
+
57
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
48
58
  # Some parameter documentations has been truncated, see
49
59
  # {Spotted::Models::PagingPlaylistObject} for more details.
50
60
  #
@@ -61,6 +71,8 @@ module Spotted
61
71
  # @param total [Integer] The total number of items available to return.
62
72
  #
63
73
  # @param items [Array<Spotted::Models::SimplifiedPlaylistObject>]
74
+ #
75
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
64
76
  end
65
77
  end
66
78
  end
@@ -64,14 +64,15 @@ module Spotted
64
64
  # @return [Spotted::Models::PlaylistRetrieveResponse::Owner, nil]
65
65
  optional :owner, -> { Spotted::Models::PlaylistRetrieveResponse::Owner }
66
66
 
67
- # @!attribute public
68
- # The playlist's public/private status (if it is added to the user's profile):
69
- # `true` the playlist is public, `false` the playlist is private, `null` the
70
- # playlist status is not relevant. For more about public/private status, see
67
+ # @!attribute published
68
+ # The playlist's public/private status (if it should be added to the user's
69
+ # profile or not): `true` the playlist will be public, `false` the playlist will
70
+ # be private, `null` the playlist status is not relevant. For more about
71
+ # public/private status, see
71
72
  # [Working with Playlists](/documentation/web-api/concepts/playlists)
72
73
  #
73
74
  # @return [Boolean, nil]
74
- optional :public, Spotted::Internal::Type::Boolean
75
+ optional :published, Spotted::Internal::Type::Boolean
75
76
 
76
77
  # @!attribute snapshot_id
77
78
  # The version identifier for the current playlist. Can be supplied in other
@@ -99,7 +100,7 @@ module Spotted
99
100
  # @return [String, nil]
100
101
  optional :uri, String
101
102
 
102
- # @!method initialize(id: nil, collaborative: nil, description: nil, external_urls: nil, followers: nil, href: nil, images: nil, name: nil, owner: nil, public: nil, snapshot_id: nil, tracks: nil, type: nil, uri: nil)
103
+ # @!method initialize(id: nil, collaborative: nil, description: nil, external_urls: nil, followers: nil, href: nil, images: nil, name: nil, owner: nil, published: nil, snapshot_id: nil, tracks: nil, type: nil, uri: nil)
103
104
  # Some parameter documentations has been truncated, see
104
105
  # {Spotted::Models::PlaylistRetrieveResponse} for more details.
105
106
  #
@@ -122,7 +123,7 @@ module Spotted
122
123
  #
123
124
  # @param owner [Spotted::Models::PlaylistRetrieveResponse::Owner] The user who owns the playlist
124
125
  #
125
- # @param public [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
126
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
126
127
  #
127
128
  # @param snapshot_id [String] The version identifier for the current playlist. Can be supplied in other reques
128
129
  #
@@ -192,7 +193,17 @@ module Spotted
192
193
  # @return [Array<Spotted::Models::PlaylistTrackObject>, nil]
193
194
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::PlaylistTrackObject] }
194
195
 
195
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
196
+ # @!attribute published
197
+ # The playlist's public/private status (if it should be added to the user's
198
+ # profile or not): `true` the playlist will be public, `false` the playlist will
199
+ # be private, `null` the playlist status is not relevant. For more about
200
+ # public/private status, see
201
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
202
+ #
203
+ # @return [Boolean, nil]
204
+ optional :published, Spotted::Internal::Type::Boolean
205
+
206
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
196
207
  # Some parameter documentations has been truncated, see
197
208
  # {Spotted::Models::PlaylistRetrieveResponse::Tracks} for more details.
198
209
  #
@@ -211,6 +222,8 @@ module Spotted
211
222
  # @param total [Integer] The total number of items available to return.
212
223
  #
213
224
  # @param items [Array<Spotted::Models::PlaylistTrackObject>]
225
+ #
226
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
214
227
  end
215
228
  end
216
229
  end
@@ -24,13 +24,23 @@ module Spotted
24
24
  # @return [Boolean, nil]
25
25
  optional :is_local, Spotted::Internal::Type::Boolean
26
26
 
27
+ # @!attribute published
28
+ # The playlist's public/private status (if it should be added to the user's
29
+ # profile or not): `true` the playlist will be public, `false` the playlist will
30
+ # be private, `null` the playlist status is not relevant. For more about
31
+ # public/private status, see
32
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
33
+ #
34
+ # @return [Boolean, nil]
35
+ optional :published, Spotted::Internal::Type::Boolean
36
+
27
37
  # @!attribute track
28
38
  # Information about the track or episode.
29
39
  #
30
40
  # @return [Spotted::Models::TrackObject, Spotted::Models::EpisodeObject, nil]
31
41
  optional :track, union: -> { Spotted::PlaylistTrackObject::Track }
32
42
 
33
- # @!method initialize(added_at: nil, added_by: nil, is_local: nil, track: nil)
43
+ # @!method initialize(added_at: nil, added_by: nil, is_local: nil, published: nil, track: nil)
34
44
  # Some parameter documentations has been truncated, see
35
45
  # {Spotted::Models::PlaylistTrackObject} for more details.
36
46
  #
@@ -42,6 +52,8 @@ module Spotted
42
52
  #
43
53
  # @param is_local [Boolean] Whether this track or episode is a [local file](/documentation/web-api/concepts/
44
54
  #
55
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
56
+ #
45
57
  # @param track [Spotted::Models::TrackObject, Spotted::Models::EpisodeObject] Information about the track or episode.
46
58
 
47
59
  # Information about the track or episode.