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
@@ -152,6 +152,17 @@ module Spotted
152
152
  sig { params(mode: Integer).void }
153
153
  attr_writer :mode
154
154
 
155
+ # The playlist's public/private status (if it should be added to the user's
156
+ # profile or not): `true` the playlist will be public, `false` the playlist will
157
+ # be private, `null` the playlist status is not relevant. For more about
158
+ # public/private status, see
159
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
160
+ sig { returns(T.nilable(T::Boolean)) }
161
+ attr_reader :published
162
+
163
+ sig { params(published: T::Boolean).void }
164
+ attr_writer :published
165
+
155
166
  # Speechiness detects the presence of spoken words in a track. The more
156
167
  # exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
157
168
  # closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
@@ -238,6 +249,7 @@ module Spotted
238
249
  liveness: Float,
239
250
  loudness: Float,
240
251
  mode: Integer,
252
+ published: T::Boolean,
241
253
  speechiness: Float,
242
254
  tempo: Float,
243
255
  time_signature: Integer,
@@ -293,6 +305,12 @@ module Spotted
293
305
  # Mode indicates the modality (major or minor) of a track, the type of scale from
294
306
  # which its melodic content is derived. Major is represented by 1 and minor is 0.
295
307
  mode: nil,
308
+ # The playlist's public/private status (if it should be added to the user's
309
+ # profile or not): `true` the playlist will be public, `false` the playlist will
310
+ # be private, `null` the playlist status is not relevant. For more about
311
+ # public/private status, see
312
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
313
+ published: nil,
296
314
  # Speechiness detects the presence of spoken words in a track. The more
297
315
  # exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
298
316
  # closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
@@ -337,6 +355,7 @@ module Spotted
337
355
  liveness: Float,
338
356
  loudness: Float,
339
357
  mode: Integer,
358
+ published: T::Boolean,
340
359
  speechiness: Float,
341
360
  tempo: Float,
342
361
  time_signature: Integer,
@@ -110,6 +110,17 @@ module Spotted
110
110
  sig { params(mode: Integer).void }
111
111
  attr_writer :mode
112
112
 
113
+ # The playlist's public/private status (if it should be added to the user's
114
+ # profile or not): `true` the playlist will be public, `false` the playlist will
115
+ # be private, `null` the playlist status is not relevant. For more about
116
+ # public/private status, see
117
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
118
+ sig { returns(T.nilable(T::Boolean)) }
119
+ attr_reader :published
120
+
121
+ sig { params(published: T::Boolean).void }
122
+ attr_writer :published
123
+
113
124
  # Speechiness detects the presence of spoken words in a track. The more
114
125
  # exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
115
126
  # closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
@@ -195,6 +206,7 @@ module Spotted
195
206
  liveness: Float,
196
207
  loudness: Float,
197
208
  mode: Integer,
209
+ published: T::Boolean,
198
210
  speechiness: Float,
199
211
  tempo: Float,
200
212
  time_signature: Integer,
@@ -249,6 +261,12 @@ module Spotted
249
261
  # Mode indicates the modality (major or minor) of a track, the type of scale from
250
262
  # which its melodic content is derived. Major is represented by 1 and minor is 0.
251
263
  mode: nil,
264
+ # The playlist's public/private status (if it should be added to the user's
265
+ # profile or not): `true` the playlist will be public, `false` the playlist will
266
+ # be private, `null` the playlist status is not relevant. For more about
267
+ # public/private status, see
268
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
269
+ published: nil,
252
270
  # Speechiness detects the presence of spoken words in a track. The more
253
271
  # exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
254
272
  # closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
@@ -293,6 +311,7 @@ module Spotted
293
311
  liveness: Float,
294
312
  loudness: Float,
295
313
  mode: Integer,
314
+ published: T::Boolean,
296
315
  speechiness: Float,
297
316
  tempo: Float,
298
317
  time_signature: Integer,
@@ -97,6 +97,17 @@ module Spotted
97
97
  sig { params(edition: String).void }
98
98
  attr_writer :edition
99
99
 
100
+ # The playlist's public/private status (if it should be added to the user's
101
+ # profile or not): `true` the playlist will be public, `false` the playlist will
102
+ # be private, `null` the playlist status is not relevant. For more about
103
+ # public/private status, see
104
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
105
+ sig { returns(T.nilable(T::Boolean)) }
106
+ attr_reader :published
107
+
108
+ sig { params(published: T::Boolean).void }
109
+ attr_writer :published
110
+
100
111
  sig do
101
112
  params(
102
113
  id: String,
@@ -117,6 +128,7 @@ module Spotted
117
128
  total_chapters: Integer,
118
129
  uri: String,
119
130
  edition: String,
131
+ published: T::Boolean,
120
132
  type: Symbol
121
133
  ).returns(T.attached_class)
122
134
  end
@@ -164,6 +176,12 @@ module Spotted
164
176
  uri:,
165
177
  # The edition of the audiobook.
166
178
  edition: nil,
179
+ # The playlist's public/private status (if it should be added to the user's
180
+ # profile or not): `true` the playlist will be public, `false` the playlist will
181
+ # be private, `null` the playlist status is not relevant. For more about
182
+ # public/private status, see
183
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
184
+ published: nil,
167
185
  # The object type.
168
186
  type: :audiobook
169
187
  )
@@ -190,7 +208,8 @@ module Spotted
190
208
  total_chapters: Integer,
191
209
  type: Symbol,
192
210
  uri: String,
193
- edition: String
211
+ edition: String,
212
+ published: T::Boolean
194
213
  }
195
214
  )
196
215
  end
@@ -133,6 +133,17 @@ module Spotted
133
133
  end
134
134
  attr_writer :items
135
135
 
136
+ # The playlist's public/private status (if it should be added to the user's
137
+ # profile or not): `true` the playlist will be public, `false` the playlist will
138
+ # be private, `null` the playlist status is not relevant. For more about
139
+ # public/private status, see
140
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
141
+ sig { returns(T.nilable(T::Boolean)) }
142
+ attr_reader :published
143
+
144
+ sig { params(published: T::Boolean).void }
145
+ attr_writer :published
146
+
136
147
  # The chapters of the audiobook.
137
148
  sig do
138
149
  params(
@@ -142,7 +153,8 @@ module Spotted
142
153
  offset: Integer,
143
154
  previous: T.nilable(String),
144
155
  total: Integer,
145
- items: T::Array[Spotted::SimplifiedChapterObject::OrHash]
156
+ items: T::Array[Spotted::SimplifiedChapterObject::OrHash],
157
+ published: T::Boolean
146
158
  ).returns(T.attached_class)
147
159
  end
148
160
  def self.new(
@@ -158,7 +170,13 @@ module Spotted
158
170
  previous:,
159
171
  # The total number of items available to return.
160
172
  total:,
161
- items: nil
173
+ items: nil,
174
+ # The playlist's public/private status (if it should be added to the user's
175
+ # profile or not): `true` the playlist will be public, `false` the playlist will
176
+ # be private, `null` the playlist status is not relevant. For more about
177
+ # public/private status, see
178
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
179
+ published: nil
162
180
  )
163
181
  end
164
182
 
@@ -171,7 +189,8 @@ module Spotted
171
189
  offset: Integer,
172
190
  previous: T.nilable(String),
173
191
  total: Integer,
174
- items: T::Array[Spotted::SimplifiedChapterObject]
192
+ items: T::Array[Spotted::SimplifiedChapterObject],
193
+ published: T::Boolean
175
194
  }
176
195
  )
177
196
  end
@@ -82,6 +82,17 @@ module Spotted
82
82
  end
83
83
  attr_writer :items
84
84
 
85
+ # The playlist's public/private status (if it should be added to the user's
86
+ # profile or not): `true` the playlist will be public, `false` the playlist will
87
+ # be private, `null` the playlist status is not relevant. For more about
88
+ # public/private status, see
89
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
90
+ sig { returns(T.nilable(T::Boolean)) }
91
+ attr_reader :published
92
+
93
+ sig { params(published: T::Boolean).void }
94
+ attr_writer :published
95
+
85
96
  # The chapters of the audiobook.
86
97
  sig do
87
98
  params(
@@ -91,7 +102,8 @@ module Spotted
91
102
  offset: Integer,
92
103
  previous: T.nilable(String),
93
104
  total: Integer,
94
- items: T::Array[Spotted::SimplifiedChapterObject::OrHash]
105
+ items: T::Array[Spotted::SimplifiedChapterObject::OrHash],
106
+ published: T::Boolean
95
107
  ).returns(T.attached_class)
96
108
  end
97
109
  def self.new(
@@ -107,7 +119,13 @@ module Spotted
107
119
  previous:,
108
120
  # The total number of items available to return.
109
121
  total:,
110
- items: nil
122
+ items: nil,
123
+ # The playlist's public/private status (if it should be added to the user's
124
+ # profile or not): `true` the playlist will be public, `false` the playlist will
125
+ # be private, `null` the playlist status is not relevant. For more about
126
+ # public/private status, see
127
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
128
+ published: nil
111
129
  )
112
130
  end
113
131
 
@@ -120,7 +138,8 @@ module Spotted
120
138
  offset: Integer,
121
139
  previous: T.nilable(String),
122
140
  total: Integer,
123
- items: T::Array[Spotted::SimplifiedChapterObject]
141
+ items: T::Array[Spotted::SimplifiedChapterObject],
142
+ published: T::Boolean
124
143
  }
125
144
  )
126
145
  end
@@ -15,14 +15,33 @@ module Spotted
15
15
  sig { params(name: String).void }
16
16
  attr_writer :name
17
17
 
18
- sig { params(name: String).returns(T.attached_class) }
18
+ # The playlist's public/private status (if it should be added to the user's
19
+ # profile or not): `true` the playlist will be public, `false` the playlist will
20
+ # be private, `null` the playlist status is not relevant. For more about
21
+ # public/private status, see
22
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
23
+ sig { returns(T.nilable(T::Boolean)) }
24
+ attr_reader :published
25
+
26
+ sig { params(published: T::Boolean).void }
27
+ attr_writer :published
28
+
29
+ sig do
30
+ params(name: String, published: T::Boolean).returns(T.attached_class)
31
+ end
19
32
  def self.new(
20
33
  # The name of the author.
21
- name: nil
34
+ name: nil,
35
+ # The playlist's public/private status (if it should be added to the user's
36
+ # profile or not): `true` the playlist will be public, `false` the playlist will
37
+ # be private, `null` the playlist status is not relevant. For more about
38
+ # public/private status, see
39
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
40
+ published: nil
22
41
  )
23
42
  end
24
43
 
25
- sig { override.returns({ name: String }) }
44
+ sig { override.returns({ name: String, published: T::Boolean }) }
26
45
  def to_hash
27
46
  end
28
47
  end
@@ -25,22 +25,44 @@ module Spotted
25
25
  sig { params(playlists: Spotted::PagingPlaylistObject::OrHash).void }
26
26
  attr_writer :playlists
27
27
 
28
+ # The playlist's public/private status (if it should be added to the user's
29
+ # profile or not): `true` the playlist will be public, `false` the playlist will
30
+ # be private, `null` the playlist status is not relevant. For more about
31
+ # public/private status, see
32
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
33
+ sig { returns(T.nilable(T::Boolean)) }
34
+ attr_reader :published
35
+
36
+ sig { params(published: T::Boolean).void }
37
+ attr_writer :published
38
+
28
39
  sig do
29
40
  params(
30
41
  message: String,
31
- playlists: Spotted::PagingPlaylistObject::OrHash
42
+ playlists: Spotted::PagingPlaylistObject::OrHash,
43
+ published: T::Boolean
32
44
  ).returns(T.attached_class)
33
45
  end
34
46
  def self.new(
35
47
  # The localized message of a playlist.
36
48
  message: nil,
37
- playlists: nil
49
+ playlists: nil,
50
+ # The playlist's public/private status (if it should be added to the user's
51
+ # profile or not): `true` the playlist will be public, `false` the playlist will
52
+ # be private, `null` the playlist status is not relevant. For more about
53
+ # public/private status, see
54
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
55
+ published: nil
38
56
  )
39
57
  end
40
58
 
41
59
  sig do
42
60
  override.returns(
43
- { message: String, playlists: Spotted::PagingPlaylistObject }
61
+ {
62
+ message: String,
63
+ playlists: Spotted::PagingPlaylistObject,
64
+ published: T::Boolean
65
+ }
44
66
  )
45
67
  end
46
68
  def to_hash
@@ -99,6 +99,17 @@ module Spotted
99
99
  end
100
100
  attr_writer :items
101
101
 
102
+ # The playlist's public/private status (if it should be added to the user's
103
+ # profile or not): `true` the playlist will be public, `false` the playlist will
104
+ # be private, `null` the playlist status is not relevant. For more about
105
+ # public/private status, see
106
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
107
+ sig { returns(T.nilable(T::Boolean)) }
108
+ attr_reader :published
109
+
110
+ sig { params(published: T::Boolean).void }
111
+ attr_writer :published
112
+
102
113
  sig do
103
114
  params(
104
115
  href: String,
@@ -110,7 +121,8 @@ module Spotted
110
121
  items:
111
122
  T::Array[
112
123
  Spotted::Models::Browse::CategoryListResponse::Categories::Item::OrHash
113
- ]
124
+ ],
125
+ published: T::Boolean
114
126
  ).returns(T.attached_class)
115
127
  end
116
128
  def self.new(
@@ -126,7 +138,13 @@ module Spotted
126
138
  previous:,
127
139
  # The total number of items available to return.
128
140
  total:,
129
- items: nil
141
+ items: nil,
142
+ # The playlist's public/private status (if it should be added to the user's
143
+ # profile or not): `true` the playlist will be public, `false` the playlist will
144
+ # be private, `null` the playlist status is not relevant. For more about
145
+ # public/private status, see
146
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
147
+ published: nil
130
148
  )
131
149
  end
132
150
 
@@ -142,7 +160,8 @@ module Spotted
142
160
  items:
143
161
  T::Array[
144
162
  Spotted::Models::Browse::CategoryListResponse::Categories::Item
145
- ]
163
+ ],
164
+ published: T::Boolean
146
165
  }
147
166
  )
148
167
  end
@@ -175,12 +194,24 @@ module Spotted
175
194
  sig { returns(String) }
176
195
  attr_accessor :name
177
196
 
197
+ # The playlist's public/private status (if it should be added to the user's
198
+ # profile or not): `true` the playlist will be public, `false` the playlist will
199
+ # be private, `null` the playlist status is not relevant. For more about
200
+ # public/private status, see
201
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
202
+ sig { returns(T.nilable(T::Boolean)) }
203
+ attr_reader :published
204
+
205
+ sig { params(published: T::Boolean).void }
206
+ attr_writer :published
207
+
178
208
  sig do
179
209
  params(
180
210
  id: String,
181
211
  href: String,
182
212
  icons: T::Array[Spotted::ImageObject::OrHash],
183
- name: String
213
+ name: String,
214
+ published: T::Boolean
184
215
  ).returns(T.attached_class)
185
216
  end
186
217
  def self.new(
@@ -192,7 +223,13 @@ module Spotted
192
223
  # The category icon, in various sizes.
193
224
  icons:,
194
225
  # The name of the category.
195
- name:
226
+ name:,
227
+ # The playlist's public/private status (if it should be added to the user's
228
+ # profile or not): `true` the playlist will be public, `false` the playlist will
229
+ # be private, `null` the playlist status is not relevant. For more about
230
+ # public/private status, see
231
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
232
+ published: nil
196
233
  )
197
234
  end
198
235
 
@@ -202,7 +239,8 @@ module Spotted
202
239
  id: String,
203
240
  href: String,
204
241
  icons: T::Array[Spotted::ImageObject],
205
- name: String
242
+ name: String,
243
+ published: T::Boolean
206
244
  }
207
245
  )
208
246
  end
@@ -29,12 +29,24 @@ module Spotted
29
29
  sig { returns(String) }
30
30
  attr_accessor :name
31
31
 
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
+ sig { returns(T.nilable(T::Boolean)) }
38
+ attr_reader :published
39
+
40
+ sig { params(published: T::Boolean).void }
41
+ attr_writer :published
42
+
32
43
  sig do
33
44
  params(
34
45
  id: String,
35
46
  href: String,
36
47
  icons: T::Array[Spotted::ImageObject::OrHash],
37
- name: String
48
+ name: String,
49
+ published: T::Boolean
38
50
  ).returns(T.attached_class)
39
51
  end
40
52
  def self.new(
@@ -46,7 +58,13 @@ module Spotted
46
58
  # The category icon, in various sizes.
47
59
  icons:,
48
60
  # The name of the category.
49
- name:
61
+ name:,
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
+ published: nil
50
68
  )
51
69
  end
52
70
 
@@ -56,7 +74,8 @@ module Spotted
56
74
  id: String,
57
75
  href: String,
58
76
  icons: T::Array[Spotted::ImageObject],
59
- name: String
77
+ name: String,
78
+ published: T::Boolean
60
79
  }
61
80
  )
62
81
  end
@@ -24,22 +24,44 @@ module Spotted
24
24
  sig { params(playlists: Spotted::PagingPlaylistObject::OrHash).void }
25
25
  attr_writer :playlists
26
26
 
27
+ # The playlist's public/private status (if it should be added to the user's
28
+ # profile or not): `true` the playlist will be public, `false` the playlist will
29
+ # be private, `null` the playlist status is not relevant. For more about
30
+ # public/private status, see
31
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
32
+ sig { returns(T.nilable(T::Boolean)) }
33
+ attr_reader :published
34
+
35
+ sig { params(published: T::Boolean).void }
36
+ attr_writer :published
37
+
27
38
  sig do
28
39
  params(
29
40
  message: String,
30
- playlists: Spotted::PagingPlaylistObject::OrHash
41
+ playlists: Spotted::PagingPlaylistObject::OrHash,
42
+ published: T::Boolean
31
43
  ).returns(T.attached_class)
32
44
  end
33
45
  def self.new(
34
46
  # The localized message of a playlist.
35
47
  message: nil,
36
- playlists: nil
48
+ playlists: nil,
49
+ # The playlist's public/private status (if it should be added to the user's
50
+ # profile or not): `true` the playlist will be public, `false` the playlist will
51
+ # be private, `null` the playlist status is not relevant. For more about
52
+ # public/private status, see
53
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
54
+ published: nil
37
55
  )
38
56
  end
39
57
 
40
58
  sig do
41
59
  override.returns(
42
- { message: String, playlists: Spotted::PagingPlaylistObject }
60
+ {
61
+ message: String,
62
+ playlists: Spotted::PagingPlaylistObject,
63
+ published: T::Boolean
64
+ }
43
65
  )
44
66
  end
45
67
  def to_hash
@@ -91,6 +91,17 @@ module Spotted
91
91
  end
92
92
  attr_writer :items
93
93
 
94
+ # The playlist's public/private status (if it should be added to the user's
95
+ # profile or not): `true` the playlist will be public, `false` the playlist will
96
+ # be private, `null` the playlist status is not relevant. For more about
97
+ # public/private status, see
98
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
99
+ sig { returns(T.nilable(T::Boolean)) }
100
+ attr_reader :published
101
+
102
+ sig { params(published: T::Boolean).void }
103
+ attr_writer :published
104
+
94
105
  sig do
95
106
  params(
96
107
  href: String,
@@ -102,7 +113,8 @@ module Spotted
102
113
  items:
103
114
  T::Array[
104
115
  Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::OrHash
105
- ]
116
+ ],
117
+ published: T::Boolean
106
118
  ).returns(T.attached_class)
107
119
  end
108
120
  def self.new(
@@ -118,7 +130,13 @@ module Spotted
118
130
  previous:,
119
131
  # The total number of items available to return.
120
132
  total:,
121
- items: nil
133
+ items: nil,
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
+ published: nil
122
140
  )
123
141
  end
124
142
 
@@ -134,7 +152,8 @@ module Spotted
134
152
  items:
135
153
  T::Array[
136
154
  Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item
137
- ]
155
+ ],
156
+ published: T::Boolean
138
157
  }
139
158
  )
140
159
  end
@@ -220,6 +239,17 @@ module Spotted
220
239
  sig { returns(String) }
221
240
  attr_accessor :uri
222
241
 
242
+ # The playlist's public/private status (if it should be added to the user's
243
+ # profile or not): `true` the playlist will be public, `false` the playlist will
244
+ # be private, `null` the playlist status is not relevant. For more about
245
+ # public/private status, see
246
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
247
+ sig { returns(T.nilable(T::Boolean)) }
248
+ attr_reader :published
249
+
250
+ sig { params(published: T::Boolean).void }
251
+ attr_writer :published
252
+
223
253
  # Included in the response when a content restriction is applied.
224
254
  sig { returns(T.nilable(Spotted::AlbumRestrictionObject)) }
225
255
  attr_reader :restrictions
@@ -245,6 +275,7 @@ module Spotted
245
275
  Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::ReleaseDatePrecision::OrSymbol,
246
276
  total_tracks: Integer,
247
277
  uri: String,
278
+ published: T::Boolean,
248
279
  restrictions: Spotted::AlbumRestrictionObject::OrHash,
249
280
  type: Symbol
250
281
  ).returns(T.attached_class)
@@ -281,6 +312,12 @@ module Spotted
281
312
  # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
282
313
  # album.
283
314
  uri:,
315
+ # The playlist's public/private status (if it should be added to the user's
316
+ # profile or not): `true` the playlist will be public, `false` the playlist will
317
+ # be private, `null` the playlist status is not relevant. For more about
318
+ # public/private status, see
319
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
320
+ published: nil,
284
321
  # Included in the response when a content restriction is applied.
285
322
  restrictions: nil,
286
323
  # The object type.
@@ -306,6 +343,7 @@ module Spotted
306
343
  total_tracks: Integer,
307
344
  type: Symbol,
308
345
  uri: String,
346
+ published: T::Boolean,
309
347
  restrictions: Spotted::AlbumRestrictionObject
310
348
  }
311
349
  )
@@ -144,6 +144,17 @@ module Spotted
144
144
  sig { params(available_markets: T::Array[String]).void }
145
145
  attr_writer :available_markets
146
146
 
147
+ # The playlist's public/private status (if it should be added to the user's
148
+ # profile or not): `true` the playlist will be public, `false` the playlist will
149
+ # be private, `null` the playlist status is not relevant. For more about
150
+ # public/private status, see
151
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
152
+ sig { returns(T.nilable(T::Boolean)) }
153
+ attr_reader :published
154
+
155
+ sig { params(published: T::Boolean).void }
156
+ attr_writer :published
157
+
147
158
  # Included in the response when a content restriction is applied.
148
159
  sig { returns(T.nilable(Spotted::ChapterRestrictionObject)) }
149
160
  attr_reader :restrictions
@@ -182,6 +193,7 @@ module Spotted
182
193
  Spotted::Models::ChapterBulkRetrieveResponse::Chapter::ReleaseDatePrecision::OrSymbol,
183
194
  uri: String,
184
195
  available_markets: T::Array[String],
196
+ published: T::Boolean,
185
197
  restrictions: Spotted::ChapterRestrictionObject::OrHash,
186
198
  resume_point: Spotted::ResumePointObject::OrHash,
187
199
  type: Symbol
@@ -232,6 +244,12 @@ module Spotted
232
244
  # A list of the countries in which the chapter can be played, identified by their
233
245
  # [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
234
246
  available_markets: nil,
247
+ # The playlist's public/private status (if it should be added to the user's
248
+ # profile or not): `true` the playlist will be public, `false` the playlist will
249
+ # be private, `null` the playlist status is not relevant. For more about
250
+ # public/private status, see
251
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
252
+ published: nil,
235
253
  # Included in the response when a content restriction is applied.
236
254
  restrictions: nil,
237
255
  # The user's most recent position in the chapter. Set if the supplied access token
@@ -265,6 +283,7 @@ module Spotted
265
283
  type: Symbol,
266
284
  uri: String,
267
285
  available_markets: T::Array[String],
286
+ published: T::Boolean,
268
287
  restrictions: Spotted::ChapterRestrictionObject,
269
288
  resume_point: Spotted::ResumePointObject
270
289
  }