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
@@ -22,6 +22,17 @@ module Spotted
22
22
  sig { params(duration: Float).void }
23
23
  attr_writer :duration
24
24
 
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
+ sig { returns(T.nilable(T::Boolean)) }
31
+ attr_reader :published
32
+
33
+ sig { params(published: T::Boolean).void }
34
+ attr_writer :published
35
+
25
36
  # The starting point (in seconds) of the time interval.
26
37
  sig { returns(T.nilable(Float)) }
27
38
  attr_reader :start
@@ -30,22 +41,38 @@ module Spotted
30
41
  attr_writer :start
31
42
 
32
43
  sig do
33
- params(confidence: Float, duration: Float, start: Float).returns(
34
- T.attached_class
35
- )
44
+ params(
45
+ confidence: Float,
46
+ duration: Float,
47
+ published: T::Boolean,
48
+ start: Float
49
+ ).returns(T.attached_class)
36
50
  end
37
51
  def self.new(
38
52
  # The confidence, from 0.0 to 1.0, of the reliability of the interval.
39
53
  confidence: nil,
40
54
  # The duration (in seconds) of the time interval.
41
55
  duration: nil,
56
+ # The playlist's public/private status (if it should be added to the user's
57
+ # profile or not): `true` the playlist will be public, `false` the playlist will
58
+ # be private, `null` the playlist status is not relevant. For more about
59
+ # public/private status, see
60
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
61
+ published: nil,
42
62
  # The starting point (in seconds) of the time interval.
43
63
  start: nil
44
64
  )
45
65
  end
46
66
 
47
67
  sig do
48
- override.returns({ confidence: Float, duration: Float, start: Float })
68
+ override.returns(
69
+ {
70
+ confidence: Float,
71
+ duration: Float,
72
+ published: T::Boolean,
73
+ start: Float
74
+ }
75
+ )
49
76
  end
50
77
  def to_hash
51
78
  end
@@ -136,6 +136,17 @@ module Spotted
136
136
  sig { returns(T.nilable(String)) }
137
137
  attr_accessor :preview_url
138
138
 
139
+ # The playlist's public/private status (if it should be added to the user's
140
+ # profile or not): `true` the playlist will be public, `false` the playlist will
141
+ # be private, `null` the playlist status is not relevant. For more about
142
+ # public/private status, see
143
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
144
+ sig { returns(T.nilable(T::Boolean)) }
145
+ attr_reader :published
146
+
147
+ sig { params(published: T::Boolean).void }
148
+ attr_writer :published
149
+
139
150
  # Included in the response when a content restriction is applied.
140
151
  sig { returns(T.nilable(Spotted::TrackRestrictionObject)) }
141
152
  attr_reader :restrictions
@@ -184,6 +195,7 @@ module Spotted
184
195
  name: String,
185
196
  popularity: Integer,
186
197
  preview_url: T.nilable(String),
198
+ published: T::Boolean,
187
199
  restrictions: Spotted::TrackRestrictionObject::OrHash,
188
200
  track_number: Integer,
189
201
  type: Spotted::TrackObject::Type::OrSymbol,
@@ -242,6 +254,12 @@ module Spotted
242
254
  popularity: nil,
243
255
  # A link to a 30 second preview (MP3 format) of the track. Can be `null`
244
256
  preview_url: nil,
257
+ # The playlist's public/private status (if it should be added to the user's
258
+ # profile or not): `true` the playlist will be public, `false` the playlist will
259
+ # be private, `null` the playlist status is not relevant. For more about
260
+ # public/private status, see
261
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
262
+ published: nil,
245
263
  # Included in the response when a content restriction is applied.
246
264
  restrictions: nil,
247
265
  # The number of the track. If an album has several discs, the track number is the
@@ -274,6 +292,7 @@ module Spotted
274
292
  name: String,
275
293
  popularity: Integer,
276
294
  preview_url: T.nilable(String),
295
+ published: T::Boolean,
277
296
  restrictions: Spotted::TrackRestrictionObject,
278
297
  track_number: Integer,
279
298
  type: Spotted::TrackObject::Type::TaggedSymbol,
@@ -356,6 +375,17 @@ module Spotted
356
375
  sig { returns(String) }
357
376
  attr_accessor :uri
358
377
 
378
+ # The playlist's public/private status (if it should be added to the user's
379
+ # profile or not): `true` the playlist will be public, `false` the playlist will
380
+ # be private, `null` the playlist status is not relevant. For more about
381
+ # public/private status, see
382
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
383
+ sig { returns(T.nilable(T::Boolean)) }
384
+ attr_reader :published
385
+
386
+ sig { params(published: T::Boolean).void }
387
+ attr_writer :published
388
+
359
389
  # Included in the response when a content restriction is applied.
360
390
  sig { returns(T.nilable(Spotted::AlbumRestrictionObject)) }
361
391
  attr_reader :restrictions
@@ -382,6 +412,7 @@ module Spotted
382
412
  Spotted::TrackObject::Album::ReleaseDatePrecision::OrSymbol,
383
413
  total_tracks: Integer,
384
414
  uri: String,
415
+ published: T::Boolean,
385
416
  restrictions: Spotted::AlbumRestrictionObject::OrHash,
386
417
  type: Symbol
387
418
  ).returns(T.attached_class)
@@ -418,6 +449,12 @@ module Spotted
418
449
  # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
419
450
  # album.
420
451
  uri:,
452
+ # The playlist's public/private status (if it should be added to the user's
453
+ # profile or not): `true` the playlist will be public, `false` the playlist will
454
+ # be private, `null` the playlist status is not relevant. For more about
455
+ # public/private status, see
456
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
457
+ published: nil,
421
458
  # Included in the response when a content restriction is applied.
422
459
  restrictions: nil,
423
460
  # The object type.
@@ -442,6 +479,7 @@ module Spotted
442
479
  total_tracks: Integer,
443
480
  type: Symbol,
444
481
  uri: String,
482
+ published: T::Boolean,
445
483
  restrictions: Spotted::AlbumRestrictionObject
446
484
  }
447
485
  )
@@ -8,6 +8,17 @@ module Spotted
8
8
  T.any(Spotted::TrackRestrictionObject, Spotted::Internal::AnyHash)
9
9
  end
10
10
 
11
+ # The playlist's public/private status (if it should be added to the user's
12
+ # profile or not): `true` the playlist will be public, `false` the playlist will
13
+ # be private, `null` the playlist status is not relevant. For more about
14
+ # public/private status, see
15
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
16
+ sig { returns(T.nilable(T::Boolean)) }
17
+ attr_reader :published
18
+
19
+ sig { params(published: T::Boolean).void }
20
+ attr_writer :published
21
+
11
22
  # The reason for the restriction. Supported values:
12
23
  #
13
24
  # - `market` - The content item is not available in the given market.
@@ -24,8 +35,16 @@ module Spotted
24
35
  sig { params(reason: String).void }
25
36
  attr_writer :reason
26
37
 
27
- sig { params(reason: String).returns(T.attached_class) }
38
+ sig do
39
+ params(published: T::Boolean, reason: String).returns(T.attached_class)
40
+ end
28
41
  def self.new(
42
+ # The playlist's public/private status (if it should be added to the user's
43
+ # profile or not): `true` the playlist will be public, `false` the playlist will
44
+ # be private, `null` the playlist status is not relevant. For more about
45
+ # public/private status, see
46
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
47
+ published: nil,
29
48
  # The reason for the restriction. Supported values:
30
49
  #
31
50
  # - `market` - The content item is not available in the given market.
@@ -40,7 +59,7 @@ module Spotted
40
59
  )
41
60
  end
42
61
 
43
- sig { override.returns({ reason: String }) }
62
+ sig { override.returns({ published: T::Boolean, reason: String }) }
44
63
  def to_hash
45
64
  end
46
65
  end
@@ -51,6 +51,17 @@ module Spotted
51
51
  sig { params(images: T::Array[Spotted::ImageObject::OrHash]).void }
52
52
  attr_writer :images
53
53
 
54
+ # The playlist's public/private status (if it should be added to the user's
55
+ # profile or not): `true` the playlist will be public, `false` the playlist will
56
+ # be private, `null` the playlist status is not relevant. For more about
57
+ # public/private status, see
58
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
59
+ sig { returns(T.nilable(T::Boolean)) }
60
+ attr_reader :published
61
+
62
+ sig { params(published: T::Boolean).void }
63
+ attr_writer :published
64
+
54
65
  # The object type.
55
66
  sig do
56
67
  returns(
@@ -84,6 +95,7 @@ module Spotted
84
95
  followers: Spotted::FollowersObject::OrHash,
85
96
  href: String,
86
97
  images: T::Array[Spotted::ImageObject::OrHash],
98
+ published: T::Boolean,
87
99
  type: Spotted::Models::UserRetrieveProfileResponse::Type::OrSymbol,
88
100
  uri: String
89
101
  ).returns(T.attached_class)
@@ -102,6 +114,12 @@ module Spotted
102
114
  href: nil,
103
115
  # The user's profile image.
104
116
  images: nil,
117
+ # The playlist's public/private status (if it should be added to the user's
118
+ # profile or not): `true` the playlist will be public, `false` the playlist will
119
+ # be private, `null` the playlist status is not relevant. For more about
120
+ # public/private status, see
121
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
122
+ published: nil,
105
123
  # The object type.
106
124
  type: nil,
107
125
  # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this
@@ -119,6 +137,7 @@ module Spotted
119
137
  followers: Spotted::FollowersObject,
120
138
  href: String,
121
139
  images: T::Array[Spotted::ImageObject],
140
+ published: T::Boolean,
122
141
  type:
123
142
  Spotted::Models::UserRetrieveProfileResponse::Type::TaggedSymbol,
124
143
  uri: String
@@ -86,9 +86,10 @@ module Spotted
86
86
  end
87
87
  attr_writer :owner
88
88
 
89
- # The playlist's public/private status (if it is added to the user's profile):
90
- # `true` the playlist is public, `false` the playlist is private, `null` the
91
- # playlist status is not relevant. For more about public/private status, see
89
+ # The playlist's public/private status (if it should be added to the user's
90
+ # profile or not): `true` the playlist will be public, `false` the playlist will
91
+ # be private, `null` the playlist status is not relevant. For more about
92
+ # public/private status, see
92
93
  # [Working with Playlists](/documentation/web-api/concepts/playlists)
93
94
  sig { returns(T.nilable(T::Boolean)) }
94
95
  attr_reader :published
@@ -180,9 +181,10 @@ module Spotted
180
181
  name: nil,
181
182
  # The user who owns the playlist
182
183
  owner: nil,
183
- # The playlist's public/private status (if it is added to the user's profile):
184
- # `true` the playlist is public, `false` the playlist is private, `null` the
185
- # playlist status is not relevant. For more about public/private status, see
184
+ # The playlist's public/private status (if it should be added to the user's
185
+ # profile or not): `true` the playlist will be public, `false` the playlist will
186
+ # be private, `null` the playlist status is not relevant. For more about
187
+ # public/private status, see
186
188
  # [Working with Playlists](/documentation/web-api/concepts/playlists)
187
189
  published: nil,
188
190
  # The version identifier for the current playlist. Can be supplied in other
@@ -290,6 +292,17 @@ module Spotted
290
292
  end
291
293
  attr_writer :items
292
294
 
295
+ # The playlist's public/private status (if it should be added to the user's
296
+ # profile or not): `true` the playlist will be public, `false` the playlist will
297
+ # be private, `null` the playlist status is not relevant. For more about
298
+ # public/private status, see
299
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
300
+ sig { returns(T.nilable(T::Boolean)) }
301
+ attr_reader :published
302
+
303
+ sig { params(published: T::Boolean).void }
304
+ attr_writer :published
305
+
293
306
  # The tracks of the playlist.
294
307
  sig do
295
308
  params(
@@ -299,7 +312,8 @@ module Spotted
299
312
  offset: Integer,
300
313
  previous: T.nilable(String),
301
314
  total: Integer,
302
- items: T::Array[Spotted::PlaylistTrackObject::OrHash]
315
+ items: T::Array[Spotted::PlaylistTrackObject::OrHash],
316
+ published: T::Boolean
303
317
  ).returns(T.attached_class)
304
318
  end
305
319
  def self.new(
@@ -315,7 +329,13 @@ module Spotted
315
329
  previous:,
316
330
  # The total number of items available to return.
317
331
  total:,
318
- items: nil
332
+ items: nil,
333
+ # The playlist's public/private status (if it should be added to the user's
334
+ # profile or not): `true` the playlist will be public, `false` the playlist will
335
+ # be private, `null` the playlist status is not relevant. For more about
336
+ # public/private status, see
337
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
338
+ published: nil
319
339
  )
320
340
  end
321
341
 
@@ -328,7 +348,8 @@ module Spotted
328
348
  offset: Integer,
329
349
  previous: T.nilable(String),
330
350
  total: Integer,
331
- items: T::Array[Spotted::PlaylistTrackObject]
351
+ items: T::Array[Spotted::PlaylistTrackObject],
352
+ published: T::Boolean
332
353
  }
333
354
  )
334
355
  end
@@ -34,6 +34,7 @@ module Spotted
34
34
  genres: ::Array[String],
35
35
  label: String,
36
36
  popularity: Integer,
37
+ published: bool,
37
38
  restrictions: Spotted::AlbumRestrictionObject,
38
39
  tracks: Spotted::Models::AlbumBulkRetrieveResponse::Album::Tracks
39
40
  }
@@ -93,6 +94,10 @@ module Spotted
93
94
 
94
95
  def popularity=: (Integer) -> Integer
95
96
 
97
+ attr_reader published: bool?
98
+
99
+ def published=: (bool) -> bool
100
+
96
101
  attr_reader restrictions: Spotted::AlbumRestrictionObject?
97
102
 
98
103
  def restrictions=: (
@@ -123,6 +128,7 @@ module Spotted
123
128
  ?genres: ::Array[String],
124
129
  ?label: String,
125
130
  ?popularity: Integer,
131
+ ?published: bool,
126
132
  ?restrictions: Spotted::AlbumRestrictionObject,
127
133
  ?tracks: Spotted::Models::AlbumBulkRetrieveResponse::Album::Tracks,
128
134
  ?type: :album
@@ -147,6 +153,7 @@ module Spotted
147
153
  genres: ::Array[String],
148
154
  label: String,
149
155
  popularity: Integer,
156
+ published: bool,
150
157
  restrictions: Spotted::AlbumRestrictionObject,
151
158
  tracks: Spotted::Models::AlbumBulkRetrieveResponse::Album::Tracks
152
159
  }
@@ -183,7 +190,8 @@ module Spotted
183
190
  offset: Integer,
184
191
  previous: String?,
185
192
  total: Integer,
186
- items: ::Array[Spotted::SimplifiedTrackObject]
193
+ items: ::Array[Spotted::SimplifiedTrackObject],
194
+ published: bool
187
195
  }
188
196
 
189
197
  class Tracks < Spotted::Internal::Type::BaseModel
@@ -205,6 +213,10 @@ module Spotted
205
213
  ::Array[Spotted::SimplifiedTrackObject]
206
214
  ) -> ::Array[Spotted::SimplifiedTrackObject]
207
215
 
216
+ attr_reader published: bool?
217
+
218
+ def published=: (bool) -> bool
219
+
208
220
  def initialize: (
209
221
  href: String,
210
222
  limit: Integer,
@@ -212,7 +224,8 @@ module Spotted
212
224
  offset: Integer,
213
225
  previous: String?,
214
226
  total: Integer,
215
- ?items: ::Array[Spotted::SimplifiedTrackObject]
227
+ ?items: ::Array[Spotted::SimplifiedTrackObject],
228
+ ?published: bool
216
229
  ) -> void
217
230
 
218
231
  def to_hash: -> {
@@ -222,7 +235,8 @@ module Spotted
222
235
  offset: Integer,
223
236
  previous: String?,
224
237
  total: Integer,
225
- items: ::Array[Spotted::SimplifiedTrackObject]
238
+ items: ::Array[Spotted::SimplifiedTrackObject],
239
+ published: bool
226
240
  }
227
241
  end
228
242
  end
@@ -1,9 +1,16 @@
1
1
  module Spotted
2
2
  module Models
3
3
  type album_restriction_object =
4
- { reason: Spotted::Models::AlbumRestrictionObject::reason }
4
+ {
5
+ published: bool,
6
+ reason: Spotted::Models::AlbumRestrictionObject::reason
7
+ }
5
8
 
6
9
  class AlbumRestrictionObject < Spotted::Internal::Type::BaseModel
10
+ attr_reader published: bool?
11
+
12
+ def published=: (bool) -> bool
13
+
7
14
  attr_reader reason: Spotted::Models::AlbumRestrictionObject::reason?
8
15
 
9
16
  def reason=: (
@@ -11,10 +18,12 @@ module Spotted
11
18
  ) -> Spotted::Models::AlbumRestrictionObject::reason
12
19
 
13
20
  def initialize: (
21
+ ?published: bool,
14
22
  ?reason: Spotted::Models::AlbumRestrictionObject::reason
15
23
  ) -> void
16
24
 
17
25
  def to_hash: -> {
26
+ published: bool,
18
27
  reason: Spotted::Models::AlbumRestrictionObject::reason
19
28
  }
20
29
 
@@ -20,6 +20,7 @@ module Spotted
20
20
  genres: ::Array[String],
21
21
  label: String,
22
22
  popularity: Integer,
23
+ published: bool,
23
24
  restrictions: Spotted::AlbumRestrictionObject,
24
25
  tracks: Spotted::Models::AlbumRetrieveResponse::Tracks
25
26
  }
@@ -79,6 +80,10 @@ module Spotted
79
80
 
80
81
  def popularity=: (Integer) -> Integer
81
82
 
83
+ attr_reader published: bool?
84
+
85
+ def published=: (bool) -> bool
86
+
82
87
  attr_reader restrictions: Spotted::AlbumRestrictionObject?
83
88
 
84
89
  def restrictions=: (
@@ -109,6 +114,7 @@ module Spotted
109
114
  ?genres: ::Array[String],
110
115
  ?label: String,
111
116
  ?popularity: Integer,
117
+ ?published: bool,
112
118
  ?restrictions: Spotted::AlbumRestrictionObject,
113
119
  ?tracks: Spotted::Models::AlbumRetrieveResponse::Tracks,
114
120
  ?type: :album
@@ -133,6 +139,7 @@ module Spotted
133
139
  genres: ::Array[String],
134
140
  label: String,
135
141
  popularity: Integer,
142
+ published: bool,
136
143
  restrictions: Spotted::AlbumRestrictionObject,
137
144
  tracks: Spotted::Models::AlbumRetrieveResponse::Tracks
138
145
  }
@@ -169,7 +176,8 @@ module Spotted
169
176
  offset: Integer,
170
177
  previous: String?,
171
178
  total: Integer,
172
- items: ::Array[Spotted::SimplifiedTrackObject]
179
+ items: ::Array[Spotted::SimplifiedTrackObject],
180
+ published: bool
173
181
  }
174
182
 
175
183
  class Tracks < Spotted::Internal::Type::BaseModel
@@ -191,6 +199,10 @@ module Spotted
191
199
  ::Array[Spotted::SimplifiedTrackObject]
192
200
  ) -> ::Array[Spotted::SimplifiedTrackObject]
193
201
 
202
+ attr_reader published: bool?
203
+
204
+ def published=: (bool) -> bool
205
+
194
206
  def initialize: (
195
207
  href: String,
196
208
  limit: Integer,
@@ -198,7 +210,8 @@ module Spotted
198
210
  offset: Integer,
199
211
  previous: String?,
200
212
  total: Integer,
201
- ?items: ::Array[Spotted::SimplifiedTrackObject]
213
+ ?items: ::Array[Spotted::SimplifiedTrackObject],
214
+ ?published: bool
202
215
  ) -> void
203
216
 
204
217
  def to_hash: -> {
@@ -208,7 +221,8 @@ module Spotted
208
221
  offset: Integer,
209
222
  previous: String?,
210
223
  total: Integer,
211
- items: ::Array[Spotted::SimplifiedTrackObject]
224
+ items: ::Array[Spotted::SimplifiedTrackObject],
225
+ published: bool
212
226
  }
213
227
  end
214
228
  end
@@ -16,6 +16,7 @@ module Spotted
16
16
  total_tracks: Integer,
17
17
  type: :album,
18
18
  uri: String,
19
+ published: bool,
19
20
  restrictions: Spotted::AlbumRestrictionObject
20
21
  }
21
22
 
@@ -48,6 +49,10 @@ module Spotted
48
49
 
49
50
  attr_accessor uri: String
50
51
 
52
+ attr_reader published: bool?
53
+
54
+ def published=: (bool) -> bool
55
+
51
56
  attr_reader restrictions: Spotted::AlbumRestrictionObject?
52
57
 
53
58
  def restrictions=: (
@@ -68,6 +73,7 @@ module Spotted
68
73
  release_date_precision: Spotted::Models::ArtistListAlbumsResponse::release_date_precision,
69
74
  total_tracks: Integer,
70
75
  uri: String,
76
+ ?published: bool,
71
77
  ?restrictions: Spotted::AlbumRestrictionObject,
72
78
  ?type: :album
73
79
  ) -> void
@@ -87,6 +93,7 @@ module Spotted
87
93
  total_tracks: Integer,
88
94
  type: :album,
89
95
  uri: String,
96
+ published: bool,
90
97
  restrictions: Spotted::AlbumRestrictionObject
91
98
  }
92
99
 
@@ -10,6 +10,7 @@ module Spotted
10
10
  images: ::Array[Spotted::ImageObject],
11
11
  name: String,
12
12
  popularity: Integer,
13
+ published: bool,
13
14
  type: Spotted::Models::ArtistObject::type_,
14
15
  uri: String
15
16
  }
@@ -51,6 +52,10 @@ module Spotted
51
52
 
52
53
  def popularity=: (Integer) -> Integer
53
54
 
55
+ attr_reader published: bool?
56
+
57
+ def published=: (bool) -> bool
58
+
54
59
  attr_reader type: Spotted::Models::ArtistObject::type_?
55
60
 
56
61
  def type=: (
@@ -70,6 +75,7 @@ module Spotted
70
75
  ?images: ::Array[Spotted::ImageObject],
71
76
  ?name: String,
72
77
  ?popularity: Integer,
78
+ ?published: bool,
73
79
  ?type: Spotted::Models::ArtistObject::type_,
74
80
  ?uri: String
75
81
  ) -> void
@@ -83,6 +89,7 @@ module Spotted
83
89
  images: ::Array[Spotted::ImageObject],
84
90
  name: String,
85
91
  popularity: Integer,
92
+ published: bool,
86
93
  type: Spotted::Models::ArtistObject::type_,
87
94
  uri: String
88
95
  }
@@ -5,6 +5,7 @@ module Spotted
5
5
  bars: ::Array[Spotted::TimeIntervalObject],
6
6
  beats: ::Array[Spotted::TimeIntervalObject],
7
7
  meta: Spotted::Models::AudioAnalysisRetrieveResponse::Meta,
8
+ published: bool,
8
9
  sections: ::Array[Spotted::Models::AudioAnalysisRetrieveResponse::Section],
9
10
  segments: ::Array[Spotted::Models::AudioAnalysisRetrieveResponse::Segment],
10
11
  tatums: ::Array[Spotted::TimeIntervalObject],
@@ -30,6 +31,10 @@ module Spotted
30
31
  Spotted::Models::AudioAnalysisRetrieveResponse::Meta
31
32
  ) -> Spotted::Models::AudioAnalysisRetrieveResponse::Meta
32
33
 
34
+ attr_reader published: bool?
35
+
36
+ def published=: (bool) -> bool
37
+
33
38
  attr_reader sections: ::Array[Spotted::Models::AudioAnalysisRetrieveResponse::Section]?
34
39
 
35
40
  def sections=: (
@@ -58,6 +63,7 @@ module Spotted
58
63
  ?bars: ::Array[Spotted::TimeIntervalObject],
59
64
  ?beats: ::Array[Spotted::TimeIntervalObject],
60
65
  ?meta: Spotted::Models::AudioAnalysisRetrieveResponse::Meta,
66
+ ?published: bool,
61
67
  ?sections: ::Array[Spotted::Models::AudioAnalysisRetrieveResponse::Section],
62
68
  ?segments: ::Array[Spotted::Models::AudioAnalysisRetrieveResponse::Segment],
63
69
  ?tatums: ::Array[Spotted::TimeIntervalObject],
@@ -68,6 +74,7 @@ module Spotted
68
74
  bars: ::Array[Spotted::TimeIntervalObject],
69
75
  beats: ::Array[Spotted::TimeIntervalObject],
70
76
  meta: Spotted::Models::AudioAnalysisRetrieveResponse::Meta,
77
+ published: bool,
71
78
  sections: ::Array[Spotted::Models::AudioAnalysisRetrieveResponse::Section],
72
79
  segments: ::Array[Spotted::Models::AudioAnalysisRetrieveResponse::Segment],
73
80
  tatums: ::Array[Spotted::TimeIntervalObject],
@@ -144,6 +151,7 @@ module Spotted
144
151
  loudness: Float,
145
152
  mode: Spotted::Models::AudioAnalysisRetrieveResponse::Section::mode,
146
153
  mode_confidence: Float,
154
+ published: bool,
147
155
  start: Float,
148
156
  tempo: Float,
149
157
  tempo_confidence: Float,
@@ -182,6 +190,10 @@ module Spotted
182
190
 
183
191
  def mode_confidence=: (Float) -> Float
184
192
 
193
+ attr_reader published: bool?
194
+
195
+ def published=: (bool) -> bool
196
+
185
197
  attr_reader start: Float?
186
198
 
187
199
  def start=: (Float) -> Float
@@ -210,6 +222,7 @@ module Spotted
210
222
  ?loudness: Float,
211
223
  ?mode: Spotted::Models::AudioAnalysisRetrieveResponse::Section::mode,
212
224
  ?mode_confidence: Float,
225
+ ?published: bool,
213
226
  ?start: Float,
214
227
  ?tempo: Float,
215
228
  ?tempo_confidence: Float,
@@ -225,6 +238,7 @@ module Spotted
225
238
  loudness: Float,
226
239
  mode: Spotted::Models::AudioAnalysisRetrieveResponse::Section::mode,
227
240
  mode_confidence: Float,
241
+ published: bool,
228
242
  start: Float,
229
243
  tempo: Float,
230
244
  tempo_confidence: Float,
@@ -254,6 +268,7 @@ module Spotted
254
268
  loudness_max_time: Float,
255
269
  loudness_start: Float,
256
270
  pitches: ::Array[Float],
271
+ published: bool,
257
272
  start: Float,
258
273
  timbre: ::Array[Float]
259
274
  }
@@ -287,6 +302,10 @@ module Spotted
287
302
 
288
303
  def pitches=: (::Array[Float]) -> ::Array[Float]
289
304
 
305
+ attr_reader published: bool?
306
+
307
+ def published=: (bool) -> bool
308
+
290
309
  attr_reader start: Float?
291
310
 
292
311
  def start=: (Float) -> Float
@@ -303,6 +322,7 @@ module Spotted
303
322
  ?loudness_max_time: Float,
304
323
  ?loudness_start: Float,
305
324
  ?pitches: ::Array[Float],
325
+ ?published: bool,
306
326
  ?start: Float,
307
327
  ?timbre: ::Array[Float]
308
328
  ) -> void
@@ -315,6 +335,7 @@ module Spotted
315
335
  loudness_max_time: Float,
316
336
  loudness_start: Float,
317
337
  pitches: ::Array[Float],
338
+ published: bool,
318
339
  start: Float,
319
340
  timbre: ::Array[Float]
320
341
  }