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
@@ -10,18 +10,30 @@ module Spotted
10
10
  # @return [String, nil]
11
11
  optional :href, String
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
  # Number of tracks in the playlist.
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::PlaylistTracksRefObject} for more details.
22
32
  #
23
33
  # @param href [String] A link to the Web API endpoint where full details of the playlist's tracks can b
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] Number of tracks in the playlist.
26
38
  end
27
39
  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.
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::PlaylistUserObject} 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 for this user.
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 [Symbol, Spotted::Models::PlaylistUserObject::Type] The object type.
49
61
  #
50
62
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this use
@@ -16,13 +16,25 @@ module Spotted
16
16
  # @return [Array<Spotted::Models::TrackObject>]
17
17
  required :tracks, -> { Spotted::Internal::Type::ArrayOf[Spotted::TrackObject] }
18
18
 
19
- # @!method initialize(seeds:, tracks:)
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
+
29
+ # @!method initialize(seeds:, tracks:, published: nil)
20
30
  # Some parameter documentations has been truncated, see
21
31
  # {Spotted::Models::RecommendationGetResponse} for more details.
22
32
  #
23
33
  # @param seeds [Array<Spotted::Models::RecommendationGetResponse::Seed>] An array of recommendation seed objects.
24
34
  #
25
35
  # @param tracks [Array<Spotted::Models::TrackObject>] An array of track objects ordered according to the parameters supplied.
36
+ #
37
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
26
38
 
27
39
  class Seed < Spotted::Internal::Type::BaseModel
28
40
  # @!attribute id
@@ -59,13 +71,23 @@ module Spotted
59
71
  # @return [Integer, nil]
60
72
  optional :initial_pool_size, Integer, api_name: :initialPoolSize
61
73
 
74
+ # @!attribute published
75
+ # The playlist's public/private status (if it should be added to the user's
76
+ # profile or not): `true` the playlist will be public, `false` the playlist will
77
+ # be private, `null` the playlist status is not relevant. For more about
78
+ # public/private status, see
79
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
80
+ #
81
+ # @return [Boolean, nil]
82
+ optional :published, Spotted::Internal::Type::Boolean
83
+
62
84
  # @!attribute type
63
85
  # The entity type of this seed. One of `artist`, `track` or `genre`.
64
86
  #
65
87
  # @return [String, nil]
66
88
  optional :type, String
67
89
 
68
- # @!method initialize(id: nil, after_filtering_size: nil, after_relinking_size: nil, href: nil, initial_pool_size: nil, type: nil)
90
+ # @!method initialize(id: nil, after_filtering_size: nil, after_relinking_size: nil, href: nil, initial_pool_size: nil, published: nil, type: nil)
69
91
  # Some parameter documentations has been truncated, see
70
92
  # {Spotted::Models::RecommendationGetResponse::Seed} for more details.
71
93
  #
@@ -79,6 +101,8 @@ module Spotted
79
101
  #
80
102
  # @param initial_pool_size [Integer] The number of recommended tracks available for this seed.
81
103
  #
104
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
105
+ #
82
106
  # @param type [String] The entity type of this seed. One of `artist`, `track` or `genre`.
83
107
  end
84
108
  end
@@ -9,18 +9,30 @@ module Spotted
9
9
  # @return [Boolean, nil]
10
10
  optional :fully_played, Spotted::Internal::Type::Boolean
11
11
 
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
+
12
22
  # @!attribute resume_position_ms
13
23
  # The user's most recent position in the episode in milliseconds.
14
24
  #
15
25
  # @return [Integer, nil]
16
26
  optional :resume_position_ms, Integer
17
27
 
18
- # @!method initialize(fully_played: nil, resume_position_ms: nil)
28
+ # @!method initialize(fully_played: nil, published: nil, resume_position_ms: nil)
19
29
  # Some parameter documentations has been truncated, see
20
30
  # {Spotted::Models::ResumePointObject} for more details.
21
31
  #
22
32
  # @param fully_played [Boolean] Whether or not the episode has been fully played by the user.
23
33
  #
34
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
35
+ #
24
36
  # @param resume_position_ms [Integer] The user's most recent position in the episode in milliseconds.
25
37
  end
26
38
  end
@@ -92,7 +92,17 @@ module Spotted
92
92
  optional :items,
93
93
  -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::SearchQueryResponse::Albums::Item] }
94
94
 
95
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: 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(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
96
106
  # Some parameter documentations has been truncated, see
97
107
  # {Spotted::Models::SearchQueryResponse::Albums} for more details.
98
108
  #
@@ -109,6 +119,8 @@ module Spotted
109
119
  # @param total [Integer] The total number of items available to return.
110
120
  #
111
121
  # @param items [Array<Spotted::Models::SearchQueryResponse::Albums::Item>]
122
+ #
123
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
112
124
 
113
125
  class Item < Spotted::Internal::Type::BaseModel
114
126
  # @!attribute id
@@ -197,13 +209,23 @@ module Spotted
197
209
  # @return [String]
198
210
  required :uri, String
199
211
 
212
+ # @!attribute published
213
+ # The playlist's public/private status (if it should be added to the user's
214
+ # profile or not): `true` the playlist will be public, `false` the playlist will
215
+ # be private, `null` the playlist status is not relevant. For more about
216
+ # public/private status, see
217
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
218
+ #
219
+ # @return [Boolean, nil]
220
+ optional :published, Spotted::Internal::Type::Boolean
221
+
200
222
  # @!attribute restrictions
201
223
  # Included in the response when a content restriction is applied.
202
224
  #
203
225
  # @return [Spotted::Models::AlbumRestrictionObject, nil]
204
226
  optional :restrictions, -> { Spotted::AlbumRestrictionObject }
205
227
 
206
- # @!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)
228
+ # @!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)
207
229
  # Some parameter documentations has been truncated, see
208
230
  # {Spotted::Models::SearchQueryResponse::Albums::Item} for more details.
209
231
  #
@@ -231,6 +253,8 @@ module Spotted
231
253
  #
232
254
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the albu
233
255
  #
256
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
257
+ #
234
258
  # @param restrictions [Spotted::Models::AlbumRestrictionObject] Included in the response when a content restriction is applied.
235
259
  #
236
260
  # @param type [Symbol, :album] The object type.
@@ -308,7 +332,17 @@ module Spotted
308
332
  # @return [Array<Spotted::Models::ArtistObject>, nil]
309
333
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::ArtistObject] }
310
334
 
311
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
335
+ # @!attribute published
336
+ # The playlist's public/private status (if it should be added to the user's
337
+ # profile or not): `true` the playlist will be public, `false` the playlist will
338
+ # be private, `null` the playlist status is not relevant. For more about
339
+ # public/private status, see
340
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
341
+ #
342
+ # @return [Boolean, nil]
343
+ optional :published, Spotted::Internal::Type::Boolean
344
+
345
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
312
346
  # Some parameter documentations has been truncated, see
313
347
  # {Spotted::Models::SearchQueryResponse::Artists} for more details.
314
348
  #
@@ -325,6 +359,8 @@ module Spotted
325
359
  # @param total [Integer] The total number of items available to return.
326
360
  #
327
361
  # @param items [Array<Spotted::Models::ArtistObject>]
362
+ #
363
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
328
364
  end
329
365
 
330
366
  # @see Spotted::Models::SearchQueryResponse#audiobooks
@@ -370,7 +406,17 @@ module Spotted
370
406
  # @return [Array<Spotted::Models::AudiobookBase>, nil]
371
407
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::AudiobookBase] }
372
408
 
373
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
409
+ # @!attribute published
410
+ # The playlist's public/private status (if it should be added to the user's
411
+ # profile or not): `true` the playlist will be public, `false` the playlist will
412
+ # be private, `null` the playlist status is not relevant. For more about
413
+ # public/private status, see
414
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
415
+ #
416
+ # @return [Boolean, nil]
417
+ optional :published, Spotted::Internal::Type::Boolean
418
+
419
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
374
420
  # Some parameter documentations has been truncated, see
375
421
  # {Spotted::Models::SearchQueryResponse::Audiobooks} for more details.
376
422
  #
@@ -387,6 +433,8 @@ module Spotted
387
433
  # @param total [Integer] The total number of items available to return.
388
434
  #
389
435
  # @param items [Array<Spotted::Models::AudiobookBase>]
436
+ #
437
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
390
438
  end
391
439
 
392
440
  # @see Spotted::Models::SearchQueryResponse#episodes
@@ -432,7 +480,17 @@ module Spotted
432
480
  # @return [Array<Spotted::Models::SimplifiedEpisodeObject>, nil]
433
481
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedEpisodeObject] }
434
482
 
435
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
483
+ # @!attribute published
484
+ # The playlist's public/private status (if it should be added to the user's
485
+ # profile or not): `true` the playlist will be public, `false` the playlist will
486
+ # be private, `null` the playlist status is not relevant. For more about
487
+ # public/private status, see
488
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
489
+ #
490
+ # @return [Boolean, nil]
491
+ optional :published, Spotted::Internal::Type::Boolean
492
+
493
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
436
494
  # Some parameter documentations has been truncated, see
437
495
  # {Spotted::Models::SearchQueryResponse::Episodes} for more details.
438
496
  #
@@ -449,6 +507,8 @@ module Spotted
449
507
  # @param total [Integer] The total number of items available to return.
450
508
  #
451
509
  # @param items [Array<Spotted::Models::SimplifiedEpisodeObject>]
510
+ #
511
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
452
512
  end
453
513
 
454
514
  # @see Spotted::Models::SearchQueryResponse#shows
@@ -494,7 +554,17 @@ module Spotted
494
554
  # @return [Array<Spotted::Models::ShowBase>, nil]
495
555
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::ShowBase] }
496
556
 
497
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
557
+ # @!attribute published
558
+ # The playlist's public/private status (if it should be added to the user's
559
+ # profile or not): `true` the playlist will be public, `false` the playlist will
560
+ # be private, `null` the playlist status is not relevant. For more about
561
+ # public/private status, see
562
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
563
+ #
564
+ # @return [Boolean, nil]
565
+ optional :published, Spotted::Internal::Type::Boolean
566
+
567
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
498
568
  # Some parameter documentations has been truncated, see
499
569
  # {Spotted::Models::SearchQueryResponse::Shows} for more details.
500
570
  #
@@ -511,6 +581,8 @@ module Spotted
511
581
  # @param total [Integer] The total number of items available to return.
512
582
  #
513
583
  # @param items [Array<Spotted::Models::ShowBase>]
584
+ #
585
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
514
586
  end
515
587
 
516
588
  # @see Spotted::Models::SearchQueryResponse#tracks
@@ -556,7 +628,17 @@ module Spotted
556
628
  # @return [Array<Spotted::Models::TrackObject>, nil]
557
629
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::TrackObject] }
558
630
 
559
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
631
+ # @!attribute published
632
+ # The playlist's public/private status (if it should be added to the user's
633
+ # profile or not): `true` the playlist will be public, `false` the playlist will
634
+ # be private, `null` the playlist status is not relevant. For more about
635
+ # public/private status, see
636
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
637
+ #
638
+ # @return [Boolean, nil]
639
+ optional :published, Spotted::Internal::Type::Boolean
640
+
641
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
560
642
  # Some parameter documentations has been truncated, see
561
643
  # {Spotted::Models::SearchQueryResponse::Tracks} for more details.
562
644
  #
@@ -573,6 +655,8 @@ module Spotted
573
655
  # @param total [Integer] The total number of items available to return.
574
656
  #
575
657
  # @param items [Array<Spotted::Models::TrackObject>]
658
+ #
659
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
576
660
  end
577
661
  end
578
662
  end
@@ -111,7 +111,17 @@ module Spotted
111
111
  # @return [String]
112
112
  required :uri, String
113
113
 
114
- # @!method initialize(id:, available_markets:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, languages:, media_type:, name:, publisher:, total_episodes:, uri:, type: :show)
114
+ # @!attribute published
115
+ # The playlist's public/private status (if it should be added to the user's
116
+ # profile or not): `true` the playlist will be public, `false` the playlist will
117
+ # be private, `null` the playlist status is not relevant. For more about
118
+ # public/private status, see
119
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
120
+ #
121
+ # @return [Boolean, nil]
122
+ optional :published, Spotted::Internal::Type::Boolean
123
+
124
+ # @!method initialize(id:, available_markets:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, languages:, media_type:, name:, publisher:, total_episodes:, uri:, published: nil, type: :show)
115
125
  # Some parameter documentations has been truncated, see
116
126
  # {Spotted::Models::ShowBase} for more details.
117
127
  #
@@ -147,6 +157,8 @@ module Spotted
147
157
  #
148
158
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show
149
159
  #
160
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
161
+ #
150
162
  # @param type [Symbol, :show] The object type.
151
163
  end
152
164
  end
@@ -58,7 +58,17 @@ module Spotted
58
58
  # @return [Array<Spotted::Models::SimplifiedEpisodeObject>, nil]
59
59
  optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedEpisodeObject] }
60
60
 
61
- # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
61
+ # @!attribute published
62
+ # The playlist's public/private status (if it should be added to the user's
63
+ # profile or not): `true` the playlist will be public, `false` the playlist will
64
+ # be private, `null` the playlist status is not relevant. For more about
65
+ # public/private status, see
66
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
67
+ #
68
+ # @return [Boolean, nil]
69
+ optional :published, Spotted::Internal::Type::Boolean
70
+
71
+ # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
62
72
  # Some parameter documentations has been truncated, see
63
73
  # {Spotted::Models::ShowRetrieveResponse::Episodes} for more details.
64
74
  #
@@ -77,6 +87,8 @@ module Spotted
77
87
  # @param total [Integer] The total number of items available to return.
78
88
  #
79
89
  # @param items [Array<Spotted::Models::SimplifiedEpisodeObject>]
90
+ #
91
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
80
92
  end
81
93
  end
82
94
  end
@@ -28,6 +28,16 @@ module Spotted
28
28
  # @return [String, nil]
29
29
  optional :name, String
30
30
 
31
+ # @!attribute published
32
+ # The playlist's public/private status (if it should be added to the user's
33
+ # profile or not): `true` the playlist will be public, `false` the playlist will
34
+ # be private, `null` the playlist status is not relevant. For more about
35
+ # public/private status, see
36
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
37
+ #
38
+ # @return [Boolean, nil]
39
+ optional :published, Spotted::Internal::Type::Boolean
40
+
31
41
  # @!attribute type
32
42
  # The object type.
33
43
  #
@@ -41,7 +51,7 @@ module Spotted
41
51
  # @return [String, nil]
42
52
  optional :uri, String
43
53
 
44
- # @!method initialize(id: nil, external_urls: nil, href: nil, name: nil, type: nil, uri: nil)
54
+ # @!method initialize(id: nil, external_urls: nil, href: nil, name: nil, published: nil, type: nil, uri: nil)
45
55
  # Some parameter documentations has been truncated, see
46
56
  # {Spotted::Models::SimplifiedArtistObject} for more details.
47
57
  #
@@ -53,6 +63,8 @@ module Spotted
53
63
  #
54
64
  # @param name [String] The name of the artist.
55
65
  #
66
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
67
+ #
56
68
  # @param type [Symbol, Spotted::Models::SimplifiedArtistObject::Type] The object type.
57
69
  #
58
70
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the arti
@@ -122,6 +122,16 @@ module Spotted
122
122
  # @return [Array<String>, nil]
123
123
  optional :available_markets, Spotted::Internal::Type::ArrayOf[String]
124
124
 
125
+ # @!attribute published
126
+ # The playlist's public/private status (if it should be added to the user's
127
+ # profile or not): `true` the playlist will be public, `false` the playlist will
128
+ # be private, `null` the playlist status is not relevant. For more about
129
+ # public/private status, see
130
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
131
+ #
132
+ # @return [Boolean, nil]
133
+ optional :published, Spotted::Internal::Type::Boolean
134
+
125
135
  # @!attribute restrictions
126
136
  # Included in the response when a content restriction is applied.
127
137
  #
@@ -135,7 +145,7 @@ module Spotted
135
145
  # @return [Spotted::Models::ResumePointObject, nil]
136
146
  optional :resume_point, -> { Spotted::ResumePointObject }
137
147
 
138
- # @!method initialize(id:, audio_preview_url:, 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)
148
+ # @!method initialize(id:, audio_preview_url:, 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)
139
149
  # Some parameter documentations has been truncated, see
140
150
  # {Spotted::Models::SimplifiedChapterObject} for more details.
141
151
  #
@@ -173,6 +183,8 @@ module Spotted
173
183
  #
174
184
  # @param available_markets [Array<String>] A list of the countries in which the chapter can be played, identified by their
175
185
  #
186
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
187
+ #
176
188
  # @param restrictions [Spotted::Models::ChapterRestrictionObject] Included in the response when a content restriction is applied.
177
189
  #
178
190
  # @param resume_point [Spotted::Models::ResumePointObject] The user's most recent position in the chapter. Set if the supplied access token
@@ -124,6 +124,16 @@ module Spotted
124
124
  # @return [String, nil]
125
125
  optional :language, String
126
126
 
127
+ # @!attribute published
128
+ # The playlist's public/private status (if it should be added to the user's
129
+ # profile or not): `true` the playlist will be public, `false` the playlist will
130
+ # be private, `null` the playlist status is not relevant. For more about
131
+ # public/private status, see
132
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
133
+ #
134
+ # @return [Boolean, nil]
135
+ optional :published, Spotted::Internal::Type::Boolean
136
+
127
137
  # @!attribute restrictions
128
138
  # Included in the response when a content restriction is applied.
129
139
  #
@@ -137,7 +147,7 @@ module Spotted
137
147
  # @return [Spotted::Models::ResumePointObject, nil]
138
148
  optional :resume_point, -> { Spotted::ResumePointObject }
139
149
 
140
- # @!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:, uri:, language: nil, restrictions: nil, resume_point: nil, type: :episode)
150
+ # @!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:, uri:, language: nil, published: nil, restrictions: nil, resume_point: nil, type: :episode)
141
151
  # Some parameter documentations has been truncated, see
142
152
  # {Spotted::Models::SimplifiedEpisodeObject} for more details.
143
153
  #
@@ -175,6 +185,8 @@ module Spotted
175
185
  #
176
186
  # @param language [String] The language used in the episode, identified by a [ISO 639](https://en.wikipedia
177
187
  #
188
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
189
+ #
178
190
  # @param restrictions [Spotted::Models::EpisodeRestrictionObject] Included in the response when a content restriction is applied.
179
191
  #
180
192
  # @param resume_point [Spotted::Models::ResumePointObject] The user's most recent position in the episode. Set if the supplied access token
@@ -58,9 +58,10 @@ module Spotted
58
58
  optional :owner, -> { Spotted::SimplifiedPlaylistObject::Owner }
59
59
 
60
60
  # @!attribute published
61
- # The playlist's public/private status (if it is added to the user's profile):
62
- # `true` the playlist is public, `false` the playlist is private, `null` the
63
- # playlist status is not relevant. For more about public/private status, see
61
+ # The playlist's public/private status (if it should be added to the user's
62
+ # profile or not): `true` the playlist will be public, `false` the playlist will
63
+ # be private, `null` the playlist status is not relevant. For more about
64
+ # public/private status, see
64
65
  # [Working with Playlists](/documentation/web-api/concepts/playlists)
65
66
  #
66
67
  # @return [Boolean, nil]
@@ -116,7 +117,7 @@ module Spotted
116
117
  #
117
118
  # @param owner [Spotted::Models::SimplifiedPlaylistObject::Owner] The user who owns the playlist
118
119
  #
119
- # @param published [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
120
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
120
121
  #
121
122
  # @param snapshot_id [String] The version identifier for the current playlist. Can be supplied in other reques
122
123
  #
@@ -93,6 +93,16 @@ module Spotted
93
93
  # @return [String, nil]
94
94
  optional :preview_url, String, nil?: true
95
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
+
96
106
  # @!attribute restrictions
97
107
  # Included in the response when a content restriction is applied.
98
108
  #
@@ -119,7 +129,7 @@ module Spotted
119
129
  # @return [String, nil]
120
130
  optional :uri, String
121
131
 
122
- # @!method initialize(id: nil, artists: nil, available_markets: nil, disc_number: nil, duration_ms: nil, explicit: nil, external_urls: nil, href: nil, is_local: nil, is_playable: nil, linked_from: nil, name: nil, preview_url: nil, restrictions: nil, track_number: nil, type: nil, uri: nil)
132
+ # @!method initialize(id: nil, artists: nil, available_markets: nil, disc_number: nil, duration_ms: nil, explicit: nil, external_urls: nil, href: nil, is_local: nil, is_playable: nil, linked_from: nil, name: nil, preview_url: nil, published: nil, restrictions: nil, track_number: nil, type: nil, uri: nil)
123
133
  # Some parameter documentations has been truncated, see
124
134
  # {Spotted::Models::SimplifiedTrackObject} for more details.
125
135
  #
@@ -149,6 +159,8 @@ module Spotted
149
159
  #
150
160
  # @param preview_url [String, nil] A URL to a 30 second preview (MP3 format) of the track.
151
161
  #
162
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
163
+ #
152
164
  # @param restrictions [Spotted::Models::TrackRestrictionObject] Included in the response when a content restriction is applied.
153
165
  #
154
166
  # @param track_number [Integer] The number of the track. If an album has several discs, the track number is the
@@ -15,17 +15,32 @@ module Spotted
15
15
  # @return [Float, nil]
16
16
  optional :duration, Float
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 start
19
29
  # The starting point (in seconds) of the time interval.
20
30
  #
21
31
  # @return [Float, nil]
22
32
  optional :start, Float
23
33
 
24
- # @!method initialize(confidence: nil, duration: nil, start: nil)
34
+ # @!method initialize(confidence: nil, duration: nil, published: nil, start: nil)
35
+ # Some parameter documentations has been truncated, see
36
+ # {Spotted::Models::TimeIntervalObject} for more details.
37
+ #
25
38
  # @param confidence [Float] The confidence, from 0.0 to 1.0, of the reliability of the interval.
26
39
  #
27
40
  # @param duration [Float] The duration (in seconds) of the time interval.
28
41
  #
42
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
43
+ #
29
44
  # @param start [Float] The starting point (in seconds) of the time interval.
30
45
  end
31
46
  end