spotted 0.24.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 (191) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -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 +18 -5
  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 +5 -4
  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 +18 -5
  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 +30 -9
  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 +8 -6
  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 +30 -9
  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 +10 -3
  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_track_object.rbs +7 -0
  186. data/sig/spotted/models/time_interval_object.rbs +12 -2
  187. data/sig/spotted/models/track_object.rbs +14 -0
  188. data/sig/spotted/models/track_restriction_object.rbs +7 -3
  189. data/sig/spotted/models/user_retrieve_profile_response.rbs +7 -0
  190. data/sig/spotted/models/users/playlist_create_response.rbs +10 -3
  191. metadata +2 -2
@@ -30,7 +30,17 @@ module Spotted
30
30
  # @return [String]
31
31
  required :name, String
32
32
 
33
- # @!method initialize(id:, href:, icons:, name:)
33
+ # @!attribute published
34
+ # The playlist's public/private status (if it should be added to the user's
35
+ # profile or not): `true` the playlist will be public, `false` the playlist will
36
+ # be private, `null` the playlist status is not relevant. For more about
37
+ # public/private status, see
38
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
39
+ #
40
+ # @return [Boolean, nil]
41
+ optional :published, Spotted::Internal::Type::Boolean
42
+
43
+ # @!method initialize(id:, href:, icons:, name:, published: nil)
34
44
  # Some parameter documentations has been truncated, see
35
45
  # {Spotted::Models::Browse::CategoryRetrieveResponse} for more details.
36
46
  #
@@ -41,6 +51,8 @@ module Spotted
41
51
  # @param icons [Array<Spotted::Models::ImageObject>] The category icon, in various sizes.
42
52
  #
43
53
  # @param name [String] The name of the category.
54
+ #
55
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
44
56
  end
45
57
  end
46
58
  end
@@ -15,13 +15,25 @@ module Spotted
15
15
  # @return [Spotted::Models::PagingPlaylistObject, nil]
16
16
  optional :playlists, -> { Spotted::PagingPlaylistObject }
17
17
 
18
- # @!method initialize(message: nil, playlists: nil)
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
+
28
+ # @!method initialize(message: nil, playlists: nil, published: nil)
19
29
  # Some parameter documentations has been truncated, see
20
30
  # {Spotted::Models::BrowseGetFeaturedPlaylistsResponse} for more details.
21
31
  #
22
32
  # @param message [String] The localized message of a playlist.
23
33
  #
24
34
  # @param playlists [Spotted::Models::PagingPlaylistObject]
35
+ #
36
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
25
37
  end
26
38
  end
27
39
  end
@@ -56,7 +56,17 @@ module Spotted
56
56
  optional :items,
57
57
  -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item] }
58
58
 
59
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
59
+ # @!attribute published
60
+ # The playlist's public/private status (if it should be added to the user's
61
+ # profile or not): `true` the playlist will be public, `false` the playlist will
62
+ # be private, `null` the playlist status is not relevant. For more about
63
+ # public/private status, see
64
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
65
+ #
66
+ # @return [Boolean, nil]
67
+ optional :published, Spotted::Internal::Type::Boolean
68
+
69
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
60
70
  # Some parameter documentations has been truncated, see
61
71
  # {Spotted::Models::BrowseGetNewReleasesResponse::Albums} for more details.
62
72
  #
@@ -73,6 +83,8 @@ module Spotted
73
83
  # @param total [Integer] The total number of items available to return.
74
84
  #
75
85
  # @param items [Array<Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item>]
86
+ #
87
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
76
88
 
77
89
  class Item < Spotted::Internal::Type::BaseModel
78
90
  # @!attribute id
@@ -161,13 +173,23 @@ module Spotted
161
173
  # @return [String]
162
174
  required :uri, String
163
175
 
176
+ # @!attribute published
177
+ # The playlist's public/private status (if it should be added to the user's
178
+ # profile or not): `true` the playlist will be public, `false` the playlist will
179
+ # be private, `null` the playlist status is not relevant. For more about
180
+ # public/private status, see
181
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
182
+ #
183
+ # @return [Boolean, nil]
184
+ optional :published, Spotted::Internal::Type::Boolean
185
+
164
186
  # @!attribute restrictions
165
187
  # Included in the response when a content restriction is applied.
166
188
  #
167
189
  # @return [Spotted::Models::AlbumRestrictionObject, nil]
168
190
  optional :restrictions, -> { Spotted::AlbumRestrictionObject }
169
191
 
170
- # @!method initialize(id:, album_type:, artists:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, uri:, restrictions: nil, type: :album)
192
+ # @!method initialize(id:, album_type:, artists:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, uri:, published: nil, restrictions: nil, type: :album)
171
193
  # Some parameter documentations has been truncated, see
172
194
  # {Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item} for more details.
173
195
  #
@@ -195,6 +217,8 @@ module Spotted
195
217
  #
196
218
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the albu
197
219
  #
220
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
221
+ #
198
222
  # @param restrictions [Spotted::Models::AlbumRestrictionObject] Included in the response when a content restriction is applied.
199
223
  #
200
224
  # @param type [Symbol, :album] The object type.
@@ -139,6 +139,16 @@ module Spotted
139
139
  # @return [Array<String>, nil]
140
140
  optional :available_markets, Spotted::Internal::Type::ArrayOf[String]
141
141
 
142
+ # @!attribute published
143
+ # The playlist's public/private status (if it should be added to the user's
144
+ # profile or not): `true` the playlist will be public, `false` the playlist will
145
+ # be private, `null` the playlist status is not relevant. For more about
146
+ # public/private status, see
147
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
148
+ #
149
+ # @return [Boolean, nil]
150
+ optional :published, Spotted::Internal::Type::Boolean
151
+
142
152
  # @!attribute restrictions
143
153
  # Included in the response when a content restriction is applied.
144
154
  #
@@ -152,7 +162,7 @@ module Spotted
152
162
  # @return [Spotted::Models::ResumePointObject, nil]
153
163
  optional :resume_point, -> { Spotted::ResumePointObject }
154
164
 
155
- # @!method initialize(id:, audio_preview_url:, audiobook:, chapter_number:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_playable:, languages:, name:, release_date:, release_date_precision:, uri:, available_markets: nil, restrictions: nil, resume_point: nil, type: :episode)
165
+ # @!method initialize(id:, audio_preview_url:, audiobook:, chapter_number:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_playable:, languages:, name:, release_date:, release_date_precision:, uri:, available_markets: nil, published: nil, restrictions: nil, resume_point: nil, type: :episode)
156
166
  # Some parameter documentations has been truncated, see
157
167
  # {Spotted::Models::ChapterBulkRetrieveResponse::Chapter} for more details.
158
168
  #
@@ -192,6 +202,8 @@ module Spotted
192
202
  #
193
203
  # @param available_markets [Array<String>] A list of the countries in which the chapter can be played, identified by their
194
204
  #
205
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
206
+ #
195
207
  # @param restrictions [Spotted::Models::ChapterRestrictionObject] Included in the response when a content restriction is applied.
196
208
  #
197
209
  # @param resume_point [Spotted::Models::ResumePointObject] The user's most recent position in the chapter. Set if the supplied access token
@@ -3,6 +3,16 @@
3
3
  module Spotted
4
4
  module Models
5
5
  class ChapterRestrictionObject < Spotted::Internal::Type::BaseModel
6
+ # @!attribute published
7
+ # The playlist's public/private status (if it should be added to the user's
8
+ # profile or not): `true` the playlist will be public, `false` the playlist will
9
+ # be private, `null` the playlist status is not relevant. For more about
10
+ # public/private status, see
11
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
12
+ #
13
+ # @return [Boolean, nil]
14
+ optional :published, Spotted::Internal::Type::Boolean
15
+
6
16
  # @!attribute reason
7
17
  # The reason for the restriction. Supported values:
8
18
  #
@@ -19,10 +29,12 @@ module Spotted
19
29
  # @return [String, nil]
20
30
  optional :reason, String
21
31
 
22
- # @!method initialize(reason: nil)
32
+ # @!method initialize(published: nil, reason: nil)
23
33
  # Some parameter documentations has been truncated, see
24
34
  # {Spotted::Models::ChapterRestrictionObject} for more details.
25
35
  #
36
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
37
+ #
26
38
  # @param reason [String] The reason for the restriction. Supported values:
27
39
  end
28
40
  end
@@ -129,6 +129,16 @@ module Spotted
129
129
  # @return [Array<String>, nil]
130
130
  optional :available_markets, Spotted::Internal::Type::ArrayOf[String]
131
131
 
132
+ # @!attribute published
133
+ # The playlist's public/private status (if it should be added to the user's
134
+ # profile or not): `true` the playlist will be public, `false` the playlist will
135
+ # be private, `null` the playlist status is not relevant. For more about
136
+ # public/private status, see
137
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
138
+ #
139
+ # @return [Boolean, nil]
140
+ optional :published, Spotted::Internal::Type::Boolean
141
+
132
142
  # @!attribute restrictions
133
143
  # Included in the response when a content restriction is applied.
134
144
  #
@@ -142,7 +152,7 @@ module Spotted
142
152
  # @return [Spotted::Models::ResumePointObject, nil]
143
153
  optional :resume_point, -> { Spotted::ResumePointObject }
144
154
 
145
- # @!method initialize(id:, audio_preview_url:, audiobook:, chapter_number:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_playable:, languages:, name:, release_date:, release_date_precision:, uri:, available_markets: nil, restrictions: nil, resume_point: nil, type: :episode)
155
+ # @!method initialize(id:, audio_preview_url:, audiobook:, chapter_number:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_playable:, languages:, name:, release_date:, release_date_precision:, uri:, available_markets: nil, published: nil, restrictions: nil, resume_point: nil, type: :episode)
146
156
  # Some parameter documentations has been truncated, see
147
157
  # {Spotted::Models::ChapterRetrieveResponse} for more details.
148
158
  #
@@ -182,6 +192,8 @@ module Spotted
182
192
  #
183
193
  # @param available_markets [Array<String>] A list of the countries in which the chapter can be played, identified by their
184
194
  #
195
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
196
+ #
185
197
  # @param restrictions [Spotted::Models::ChapterRestrictionObject] Included in the response when a content restriction is applied.
186
198
  #
187
199
  # @param resume_point [Spotted::Models::ResumePointObject] The user's most recent position in the chapter. Set if the supplied access token
@@ -3,6 +3,16 @@
3
3
  module Spotted
4
4
  module Models
5
5
  class CopyrightObject < Spotted::Internal::Type::BaseModel
6
+ # @!attribute published
7
+ # The playlist's public/private status (if it should be added to the user's
8
+ # profile or not): `true` the playlist will be public, `false` the playlist will
9
+ # be private, `null` the playlist status is not relevant. For more about
10
+ # public/private status, see
11
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
12
+ #
13
+ # @return [Boolean, nil]
14
+ optional :published, Spotted::Internal::Type::Boolean
15
+
6
16
  # @!attribute text
7
17
  # The copyright text for this content.
8
18
  #
@@ -16,10 +26,12 @@ module Spotted
16
26
  # @return [String, nil]
17
27
  optional :type, String
18
28
 
19
- # @!method initialize(text: nil, type: nil)
29
+ # @!method initialize(published: nil, text: nil, type: nil)
20
30
  # Some parameter documentations has been truncated, see
21
31
  # {Spotted::Models::CopyrightObject} for more details.
22
32
  #
33
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
34
+ #
23
35
  # @param text [String] The copyright text for this content.
24
36
  #
25
37
  # @param type [String] The type of copyright: `C` = the copyright, `P` = the sound recording (performan
@@ -130,6 +130,16 @@ module Spotted
130
130
  # @return [String, nil]
131
131
  optional :language, String
132
132
 
133
+ # @!attribute published
134
+ # The playlist's public/private status (if it should be added to the user's
135
+ # profile or not): `true` the playlist will be public, `false` the playlist will
136
+ # be private, `null` the playlist status is not relevant. For more about
137
+ # public/private status, see
138
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
139
+ #
140
+ # @return [Boolean, nil]
141
+ optional :published, Spotted::Internal::Type::Boolean
142
+
133
143
  # @!attribute restrictions
134
144
  # Included in the response when a content restriction is applied.
135
145
  #
@@ -143,7 +153,7 @@ module Spotted
143
153
  # @return [Spotted::Models::ResumePointObject, nil]
144
154
  optional :resume_point, -> { Spotted::ResumePointObject }
145
155
 
146
- # @!method initialize(id:, audio_preview_url:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, is_playable:, languages:, name:, release_date:, release_date_precision:, show:, uri:, language: nil, restrictions: nil, resume_point: nil, type: :episode)
156
+ # @!method initialize(id:, audio_preview_url:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, is_playable:, languages:, name:, release_date:, release_date_precision:, show:, uri:, language: nil, published: nil, restrictions: nil, resume_point: nil, type: :episode)
147
157
  # Some parameter documentations has been truncated, see
148
158
  # {Spotted::Models::EpisodeObject} for more details.
149
159
  #
@@ -183,6 +193,8 @@ module Spotted
183
193
  #
184
194
  # @param language [String] The language used in the episode, identified by a [ISO 639](https://en.wikipedia
185
195
  #
196
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
197
+ #
186
198
  # @param restrictions [Spotted::Models::EpisodeRestrictionObject] Included in the response when a content restriction is applied.
187
199
  #
188
200
  # @param resume_point [Spotted::Models::ResumePointObject] The user's most recent position in the episode. Set if the supplied access token
@@ -3,6 +3,16 @@
3
3
  module Spotted
4
4
  module Models
5
5
  class EpisodeRestrictionObject < Spotted::Internal::Type::BaseModel
6
+ # @!attribute published
7
+ # The playlist's public/private status (if it should be added to the user's
8
+ # profile or not): `true` the playlist will be public, `false` the playlist will
9
+ # be private, `null` the playlist status is not relevant. For more about
10
+ # public/private status, see
11
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
12
+ #
13
+ # @return [Boolean, nil]
14
+ optional :published, Spotted::Internal::Type::Boolean
15
+
6
16
  # @!attribute reason
7
17
  # The reason for the restriction. Supported values:
8
18
  #
@@ -18,10 +28,12 @@ module Spotted
18
28
  # @return [String, nil]
19
29
  optional :reason, String
20
30
 
21
- # @!method initialize(reason: nil)
31
+ # @!method initialize(published: nil, reason: nil)
22
32
  # Some parameter documentations has been truncated, see
23
33
  # {Spotted::Models::EpisodeRestrictionObject} for more details.
24
34
  #
35
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
36
+ #
25
37
  # @param reason [String] The reason for the restriction. Supported values:
26
38
  end
27
39
  end
@@ -15,13 +15,23 @@ module Spotted
15
15
  # @return [String, nil]
16
16
  optional :isrc, String
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 upc
19
29
  # [Universal Product Code](http://en.wikipedia.org/wiki/Universal_Product_Code)
20
30
  #
21
31
  # @return [String, nil]
22
32
  optional :upc, String
23
33
 
24
- # @!method initialize(ean: nil, isrc: nil, upc: nil)
34
+ # @!method initialize(ean: nil, isrc: nil, published: nil, upc: nil)
25
35
  # Some parameter documentations has been truncated, see
26
36
  # {Spotted::Models::ExternalIDObject} for more details.
27
37
  #
@@ -29,6 +39,8 @@ module Spotted
29
39
  #
30
40
  # @param isrc [String] [International Standard Recording Code](http://en.wikipedia.org/wiki/Internation
31
41
  #
42
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
43
+ #
32
44
  # @param upc [String] [Universal Product Code](http://en.wikipedia.org/wiki/Universal_Product_Code)
33
45
  end
34
46
  end
@@ -3,6 +3,16 @@
3
3
  module Spotted
4
4
  module Models
5
5
  class ExternalURLObject < Spotted::Internal::Type::BaseModel
6
+ # @!attribute published
7
+ # The playlist's public/private status (if it should be added to the user's
8
+ # profile or not): `true` the playlist will be public, `false` the playlist will
9
+ # be private, `null` the playlist status is not relevant. For more about
10
+ # public/private status, see
11
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
12
+ #
13
+ # @return [Boolean, nil]
14
+ optional :published, Spotted::Internal::Type::Boolean
15
+
6
16
  # @!attribute spotify
7
17
  # The [Spotify URL](/documentation/web-api/concepts/spotify-uris-ids) for the
8
18
  # object.
@@ -10,10 +20,12 @@ module Spotted
10
20
  # @return [String, nil]
11
21
  optional :spotify, String
12
22
 
13
- # @!method initialize(spotify: nil)
23
+ # @!method initialize(published: nil, spotify: nil)
14
24
  # Some parameter documentations has been truncated, see
15
25
  # {Spotted::Models::ExternalURLObject} for more details.
16
26
  #
27
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
28
+ #
17
29
  # @param spotify [String] The [Spotify URL](/documentation/web-api/concepts/spotify-uris-ids) for the obje
18
30
  end
19
31
  end
@@ -10,18 +10,30 @@ module Spotted
10
10
  # @return [String, nil]
11
11
  optional :href, String, nil?: true
12
12
 
13
+ # @!attribute published
14
+ # The playlist's public/private status (if it should be added to the user's
15
+ # profile or not): `true` the playlist will be public, `false` the playlist will
16
+ # be private, `null` the playlist status is not relevant. For more about
17
+ # public/private status, see
18
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
19
+ #
20
+ # @return [Boolean, nil]
21
+ optional :published, Spotted::Internal::Type::Boolean
22
+
13
23
  # @!attribute total
14
24
  # The total number of followers.
15
25
  #
16
26
  # @return [Integer, nil]
17
27
  optional :total, Integer
18
28
 
19
- # @!method initialize(href: nil, total: nil)
29
+ # @!method initialize(href: nil, published: nil, total: nil)
20
30
  # Some parameter documentations has been truncated, see
21
31
  # {Spotted::Models::FollowersObject} for more details.
22
32
  #
23
33
  # @param href [String, nil] This will always be set to null, as the Web API does not support it at the momen
24
34
  #
35
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
36
+ #
25
37
  # @param total [Integer] The total number of followers.
26
38
  end
27
39
  end
@@ -21,7 +21,17 @@ module Spotted
21
21
  # @return [Integer, nil]
22
22
  required :width, Integer, nil?: true
23
23
 
24
- # @!method initialize(height:, url:, width:)
24
+ # @!attribute published
25
+ # The playlist's public/private status (if it should be added to the user's
26
+ # profile or not): `true` the playlist will be public, `false` the playlist will
27
+ # be private, `null` the playlist status is not relevant. For more about
28
+ # public/private status, see
29
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
30
+ #
31
+ # @return [Boolean, nil]
32
+ optional :published, Spotted::Internal::Type::Boolean
33
+
34
+ # @!method initialize(height:, url:, width:, published: nil)
25
35
  # Some parameter documentations has been truncated, see
26
36
  # {Spotted::Models::ImageObject} for more details.
27
37
  #
@@ -30,6 +40,8 @@ module Spotted
30
40
  # @param url [String] The source URL of the image.
31
41
  #
32
42
  # @param width [Integer, nil] The image width in pixels.
43
+ #
44
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
33
45
  end
34
46
  end
35
47
  end
@@ -22,6 +22,16 @@ module Spotted
22
22
  # @return [String, nil]
23
23
  optional :href, String
24
24
 
25
+ # @!attribute published
26
+ # The playlist's public/private status (if it should be added to the user's
27
+ # profile or not): `true` the playlist will be public, `false` the playlist will
28
+ # be private, `null` the playlist status is not relevant. For more about
29
+ # public/private status, see
30
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
31
+ #
32
+ # @return [Boolean, nil]
33
+ optional :published, Spotted::Internal::Type::Boolean
34
+
25
35
  # @!attribute type
26
36
  # The object type: "track".
27
37
  #
@@ -35,7 +45,7 @@ module Spotted
35
45
  # @return [String, nil]
36
46
  optional :uri, String
37
47
 
38
- # @!method initialize(id: nil, external_urls: nil, href: nil, type: nil, uri: nil)
48
+ # @!method initialize(id: nil, external_urls: nil, href: nil, published: nil, type: nil, uri: nil)
39
49
  # Some parameter documentations has been truncated, see
40
50
  # {Spotted::Models::LinkedTrackObject} for more details.
41
51
  #
@@ -45,6 +55,8 @@ module Spotted
45
55
  #
46
56
  # @param href [String] A link to the Web API endpoint providing full details of the track.
47
57
  #
58
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
59
+ #
48
60
  # @param type [String] The object type: "track".
49
61
  #
50
62
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the trac
@@ -21,13 +21,25 @@ module Spotted
21
21
  # @return [Spotted::Models::Me::AlbumListResponse::Album, nil]
22
22
  optional :album, -> { Spotted::Models::Me::AlbumListResponse::Album }
23
23
 
24
- # @!method initialize(added_at: nil, album: nil)
24
+ # @!attribute published
25
+ # The playlist's public/private status (if it should be added to the user's
26
+ # profile or not): `true` the playlist will be public, `false` the playlist will
27
+ # be private, `null` the playlist status is not relevant. For more about
28
+ # public/private status, see
29
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
30
+ #
31
+ # @return [Boolean, nil]
32
+ optional :published, Spotted::Internal::Type::Boolean
33
+
34
+ # @!method initialize(added_at: nil, album: nil, published: nil)
25
35
  # Some parameter documentations has been truncated, see
26
36
  # {Spotted::Models::Me::AlbumListResponse} for more details.
27
37
  #
28
38
  # @param added_at [Time] The date and time the album was saved
29
39
  #
30
40
  # @param album [Spotted::Models::Me::AlbumListResponse::Album] Information about the album.
41
+ #
42
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
31
43
 
32
44
  # @see Spotted::Models::Me::AlbumListResponse#album
33
45
  class Album < Spotted::Internal::Type::BaseModel
@@ -150,6 +162,16 @@ module Spotted
150
162
  # @return [Integer, nil]
151
163
  optional :popularity, Integer
152
164
 
165
+ # @!attribute published
166
+ # The playlist's public/private status (if it should be added to the user's
167
+ # profile or not): `true` the playlist will be public, `false` the playlist will
168
+ # be private, `null` the playlist status is not relevant. For more about
169
+ # public/private status, see
170
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
171
+ #
172
+ # @return [Boolean, nil]
173
+ optional :published, Spotted::Internal::Type::Boolean
174
+
153
175
  # @!attribute restrictions
154
176
  # Included in the response when a content restriction is applied.
155
177
  #
@@ -162,7 +184,7 @@ module Spotted
162
184
  # @return [Spotted::Models::Me::AlbumListResponse::Album::Tracks, nil]
163
185
  optional :tracks, -> { Spotted::Models::Me::AlbumListResponse::Album::Tracks }
164
186
 
165
- # @!method initialize(id:, album_type:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, uri:, artists: nil, copyrights: nil, external_ids: nil, genres: nil, label: nil, popularity: nil, restrictions: nil, tracks: nil, type: :album)
187
+ # @!method initialize(id:, album_type:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, uri:, artists: nil, copyrights: nil, external_ids: nil, genres: nil, label: nil, popularity: nil, published: nil, restrictions: nil, tracks: nil, type: :album)
166
188
  # Some parameter documentations has been truncated, see
167
189
  # {Spotted::Models::Me::AlbumListResponse::Album} for more details.
168
190
  #
@@ -202,6 +224,8 @@ module Spotted
202
224
  #
203
225
  # @param popularity [Integer] The popularity of the album. The value will be between 0 and 100, with 100 being
204
226
  #
227
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
228
+ #
205
229
  # @param restrictions [Spotted::Models::AlbumRestrictionObject] Included in the response when a content restriction is applied.
206
230
  #
207
231
  # @param tracks [Spotted::Models::Me::AlbumListResponse::Album::Tracks] The tracks of the album.
@@ -279,7 +303,17 @@ module Spotted
279
303
  # @return [Array<Spotted::Models::SimplifiedTrackObject>, nil]
280
304
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedTrackObject] }
281
305
 
282
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
306
+ # @!attribute published
307
+ # The playlist's public/private status (if it should be added to the user's
308
+ # profile or not): `true` the playlist will be public, `false` the playlist will
309
+ # be private, `null` the playlist status is not relevant. For more about
310
+ # public/private status, see
311
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
312
+ #
313
+ # @return [Boolean, nil]
314
+ optional :published, Spotted::Internal::Type::Boolean
315
+
316
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
283
317
  # Some parameter documentations has been truncated, see
284
318
  # {Spotted::Models::Me::AlbumListResponse::Album::Tracks} for more details.
285
319
  #
@@ -298,6 +332,8 @@ module Spotted
298
332
  # @param total [Integer] The total number of items available to return.
299
333
  #
300
334
  # @param items [Array<Spotted::Models::SimplifiedTrackObject>]
335
+ #
336
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
301
337
  end
302
338
  end
303
339
  end
@@ -21,13 +21,25 @@ module Spotted
21
21
  # @return [Spotted::Models::Me::AudiobookListResponse::Audiobook, nil]
22
22
  optional :audiobook, -> { Spotted::Models::Me::AudiobookListResponse::Audiobook }
23
23
 
24
- # @!method initialize(added_at: nil, audiobook: nil)
24
+ # @!attribute published
25
+ # The playlist's public/private status (if it should be added to the user's
26
+ # profile or not): `true` the playlist will be public, `false` the playlist will
27
+ # be private, `null` the playlist status is not relevant. For more about
28
+ # public/private status, see
29
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
30
+ #
31
+ # @return [Boolean, nil]
32
+ optional :published, Spotted::Internal::Type::Boolean
33
+
34
+ # @!method initialize(added_at: nil, audiobook: nil, published: nil)
25
35
  # Some parameter documentations has been truncated, see
26
36
  # {Spotted::Models::Me::AudiobookListResponse} for more details.
27
37
  #
28
38
  # @param added_at [Time] The date and time the audiobook was saved
29
39
  #
30
40
  # @param audiobook [Spotted::Models::Me::AudiobookListResponse::Audiobook] Information about the audiobook.
41
+ #
42
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
31
43
 
32
44
  # @see Spotted::Models::Me::AudiobookListResponse#audiobook
33
45
  class Audiobook < Spotted::Models::AudiobookBase
@@ -87,7 +99,17 @@ module Spotted
87
99
  # @return [Array<Spotted::Models::SimplifiedChapterObject>, nil]
88
100
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedChapterObject] }
89
101
 
90
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
102
+ # @!attribute published
103
+ # The playlist's public/private status (if it should be added to the user's
104
+ # profile or not): `true` the playlist will be public, `false` the playlist will
105
+ # be private, `null` the playlist status is not relevant. For more about
106
+ # public/private status, see
107
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
108
+ #
109
+ # @return [Boolean, nil]
110
+ optional :published, Spotted::Internal::Type::Boolean
111
+
112
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
91
113
  # Some parameter documentations has been truncated, see
92
114
  # {Spotted::Models::Me::AudiobookListResponse::Audiobook::Chapters} for more
93
115
  # details.
@@ -107,6 +129,8 @@ module Spotted
107
129
  # @param total [Integer] The total number of items available to return.
108
130
  #
109
131
  # @param items [Array<Spotted::Models::SimplifiedChapterObject>]
132
+ #
133
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
110
134
  end
111
135
  end
112
136
  end