spotted 0.8.0 → 0.9.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 (97) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -0
  3. data/README.md +29 -1
  4. data/lib/spotted/models/{artist_list_params.rb → artist_bulk_retrieve_params.rb} +3 -3
  5. data/lib/spotted/models/{artist_list_response.rb → artist_bulk_retrieve_response.rb} +2 -2
  6. data/lib/spotted/models/{artist_list_top_tracks_params.rb → artist_top_tracks_params.rb} +3 -3
  7. data/lib/spotted/models/{track_list_response.rb → artist_top_tracks_response.rb} +2 -2
  8. data/lib/spotted/models/{audio_feature_list_params.rb → audio_feature_bulk_retrieve_params.rb} +3 -3
  9. data/lib/spotted/models/{audio_feature_list_response.rb → audio_feature_bulk_retrieve_response.rb} +11 -10
  10. data/lib/spotted/models/{audiobook_list_params.rb → audiobook_bulk_retrieve_params.rb} +3 -3
  11. data/lib/spotted/models/{audiobook_list_response.rb → audiobook_bulk_retrieve_response.rb} +11 -10
  12. data/lib/spotted/models/{chapter_list_params.rb → chapter_bulk_retrieve_params.rb} +3 -3
  13. data/lib/spotted/models/{chapter_list_response.rb → chapter_bulk_retrieve_response.rb} +15 -14
  14. data/lib/spotted/models/{episode_list_params.rb → episode_bulk_retrieve_params.rb} +3 -3
  15. data/lib/spotted/models/{episode_list_response.rb → episode_bulk_retrieve_response.rb} +2 -2
  16. data/lib/spotted/models/me/{following_list_params.rb → following_bulk_retrieve_params.rb} +6 -6
  17. data/lib/spotted/models/me/{following_list_response.rb → following_bulk_retrieve_response.rb} +11 -11
  18. data/lib/spotted/models/{search_search_params.rb → search_query_params.rb} +9 -9
  19. data/lib/spotted/models/{search_search_response.rb → search_query_response.rb} +48 -48
  20. data/lib/spotted/models/{show_list_params.rb → show_bulk_retrieve_params.rb} +3 -3
  21. data/lib/spotted/models/{show_list_response.rb → show_bulk_retrieve_response.rb} +2 -2
  22. data/lib/spotted/models/{track_list_params.rb → track_bulk_retrieve_params.rb} +3 -3
  23. data/lib/spotted/models/{artist_list_top_tracks_response.rb → track_bulk_retrieve_response.rb} +2 -2
  24. data/lib/spotted/models.rb +13 -13
  25. data/lib/spotted/resources/artists.rb +14 -14
  26. data/lib/spotted/resources/audio_features.rb +7 -7
  27. data/lib/spotted/resources/audiobooks.rb +7 -7
  28. data/lib/spotted/resources/chapters.rb +7 -7
  29. data/lib/spotted/resources/episodes.rb +7 -7
  30. data/lib/spotted/resources/me/following.rb +8 -8
  31. data/lib/spotted/resources/search.rb +9 -9
  32. data/lib/spotted/resources/shows.rb +7 -7
  33. data/lib/spotted/resources/tracks.rb +7 -7
  34. data/lib/spotted/version.rb +1 -1
  35. data/lib/spotted.rb +20 -20
  36. data/rbi/spotted/models/{artist_list_params.rbi → artist_bulk_retrieve_params.rbi} +2 -2
  37. data/rbi/spotted/models/{artist_list_response.rbi → artist_bulk_retrieve_response.rbi} +5 -2
  38. data/rbi/spotted/models/{artist_list_top_tracks_params.rbi → artist_top_tracks_params.rbi} +2 -2
  39. data/rbi/spotted/models/{artist_list_top_tracks_response.rbi → artist_top_tracks_response.rbi} +2 -2
  40. data/rbi/spotted/models/{audio_feature_list_params.rbi → audio_feature_bulk_retrieve_params.rbi} +5 -2
  41. data/rbi/spotted/models/{audio_feature_list_response.rbi → audio_feature_bulk_retrieve_response.rbi} +17 -13
  42. data/rbi/spotted/models/{audiobook_list_params.rbi → audiobook_bulk_retrieve_params.rbi} +5 -2
  43. data/rbi/spotted/models/{audiobook_list_response.rbi → audiobook_bulk_retrieve_response.rbi} +19 -11
  44. data/rbi/spotted/models/{chapter_list_params.rbi → chapter_bulk_retrieve_params.rbi} +2 -2
  45. data/rbi/spotted/models/{chapter_list_response.rbi → chapter_bulk_retrieve_response.rbi} +31 -20
  46. data/rbi/spotted/models/{episode_list_params.rbi → episode_bulk_retrieve_params.rbi} +2 -2
  47. data/rbi/spotted/models/{episode_list_response.rbi → episode_bulk_retrieve_response.rbi} +2 -2
  48. data/rbi/spotted/models/me/{following_list_params.rbi → following_bulk_retrieve_params.rbi} +18 -8
  49. data/rbi/spotted/models/me/{following_list_response.rbi → following_bulk_retrieve_response.rbi} +19 -12
  50. data/rbi/spotted/models/{search_search_params.rbi → search_query_params.rbi} +21 -21
  51. data/rbi/spotted/models/{search_search_response.rbi → search_query_response.rbi} +58 -60
  52. data/rbi/spotted/models/{show_list_params.rbi → show_bulk_retrieve_params.rbi} +2 -2
  53. data/rbi/spotted/models/{show_list_response.rbi → show_bulk_retrieve_response.rbi} +5 -2
  54. data/rbi/spotted/models/{track_list_params.rbi → track_bulk_retrieve_params.rbi} +2 -2
  55. data/rbi/spotted/models/{track_list_response.rbi → track_bulk_retrieve_response.rbi} +5 -2
  56. data/rbi/spotted/models.rbi +14 -13
  57. data/rbi/spotted/resources/artists.rbi +4 -4
  58. data/rbi/spotted/resources/audio_features.rbi +2 -2
  59. data/rbi/spotted/resources/audiobooks.rbi +2 -2
  60. data/rbi/spotted/resources/chapters.rbi +2 -2
  61. data/rbi/spotted/resources/episodes.rbi +2 -2
  62. data/rbi/spotted/resources/me/following.rbi +3 -3
  63. data/rbi/spotted/resources/search.rbi +4 -4
  64. data/rbi/spotted/resources/shows.rbi +2 -2
  65. data/rbi/spotted/resources/tracks.rbi +2 -2
  66. data/sig/spotted/models/{artist_list_params.rbs → artist_bulk_retrieve_params.rbs} +2 -2
  67. data/sig/spotted/models/{artist_list_response.rbs → artist_bulk_retrieve_response.rbs} +3 -2
  68. data/sig/spotted/models/{artist_list_top_tracks_params.rbs → artist_top_tracks_params.rbs} +2 -2
  69. data/sig/spotted/models/{track_list_response.rbs → artist_top_tracks_response.rbs} +2 -2
  70. data/sig/spotted/models/{audio_feature_list_params.rbs → audio_feature_bulk_retrieve_params.rbs} +2 -2
  71. data/sig/spotted/models/{audio_feature_list_response.rbs → audio_feature_bulk_retrieve_response.rbs} +13 -13
  72. data/sig/spotted/models/audiobook_bulk_retrieve_params.rbs +30 -0
  73. data/sig/spotted/models/{audiobook_list_response.rbs → audiobook_bulk_retrieve_response.rbs} +14 -12
  74. data/sig/spotted/models/{chapter_list_params.rbs → chapter_bulk_retrieve_params.rbs} +2 -2
  75. data/sig/spotted/models/{chapter_list_response.rbs → chapter_bulk_retrieve_response.rbs} +18 -16
  76. data/sig/spotted/models/{show_list_params.rbs → episode_bulk_retrieve_params.rbs} +2 -2
  77. data/sig/spotted/models/{episode_list_response.rbs → episode_bulk_retrieve_response.rbs} +3 -2
  78. data/sig/spotted/models/me/{following_list_params.rbs → following_bulk_retrieve_params.rbs} +7 -7
  79. data/sig/spotted/models/me/{following_list_response.rbs → following_bulk_retrieve_response.rbs} +12 -12
  80. data/sig/spotted/models/{search_search_params.rbs → search_query_params.rbs} +14 -14
  81. data/sig/spotted/models/{search_search_response.rbs → search_query_response.rbs} +57 -57
  82. data/sig/spotted/models/{episode_list_params.rbs → show_bulk_retrieve_params.rbs} +2 -2
  83. data/sig/spotted/models/{show_list_response.rbs → show_bulk_retrieve_response.rbs} +2 -2
  84. data/sig/spotted/models/{audiobook_list_params.rbs → track_bulk_retrieve_params.rbs} +2 -2
  85. data/sig/spotted/models/{artist_list_top_tracks_response.rbs → track_bulk_retrieve_response.rbs} +2 -2
  86. data/sig/spotted/models.rbs +13 -13
  87. data/sig/spotted/resources/artists.rbs +4 -4
  88. data/sig/spotted/resources/audio_features.rbs +2 -2
  89. data/sig/spotted/resources/audiobooks.rbs +2 -2
  90. data/sig/spotted/resources/chapters.rbs +2 -2
  91. data/sig/spotted/resources/episodes.rbs +2 -2
  92. data/sig/spotted/resources/me/following.rbs +3 -3
  93. data/sig/spotted/resources/search.rbs +4 -4
  94. data/sig/spotted/resources/shows.rbs +2 -2
  95. data/sig/spotted/resources/tracks.rbs +2 -2
  96. metadata +61 -61
  97. data/sig/spotted/models/track_list_params.rbs +0 -30
@@ -2,27 +2,27 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Search#search
6
- class SearchSearchResponse < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Search#query
6
+ class SearchQueryResponse < Spotted::Internal::Type::BaseModel
7
7
  # @!attribute albums
8
8
  #
9
- # @return [Spotted::Models::SearchSearchResponse::Albums, nil]
10
- optional :albums, -> { Spotted::Models::SearchSearchResponse::Albums }
9
+ # @return [Spotted::Models::SearchQueryResponse::Albums, nil]
10
+ optional :albums, -> { Spotted::Models::SearchQueryResponse::Albums }
11
11
 
12
12
  # @!attribute artists
13
13
  #
14
- # @return [Spotted::Models::SearchSearchResponse::Artists, nil]
15
- optional :artists, -> { Spotted::Models::SearchSearchResponse::Artists }
14
+ # @return [Spotted::Models::SearchQueryResponse::Artists, nil]
15
+ optional :artists, -> { Spotted::Models::SearchQueryResponse::Artists }
16
16
 
17
17
  # @!attribute audiobooks
18
18
  #
19
- # @return [Spotted::Models::SearchSearchResponse::Audiobooks, nil]
20
- optional :audiobooks, -> { Spotted::Models::SearchSearchResponse::Audiobooks }
19
+ # @return [Spotted::Models::SearchQueryResponse::Audiobooks, nil]
20
+ optional :audiobooks, -> { Spotted::Models::SearchQueryResponse::Audiobooks }
21
21
 
22
22
  # @!attribute episodes
23
23
  #
24
- # @return [Spotted::Models::SearchSearchResponse::Episodes, nil]
25
- optional :episodes, -> { Spotted::Models::SearchSearchResponse::Episodes }
24
+ # @return [Spotted::Models::SearchQueryResponse::Episodes, nil]
25
+ optional :episodes, -> { Spotted::Models::SearchQueryResponse::Episodes }
26
26
 
27
27
  # @!attribute playlists
28
28
  #
@@ -31,24 +31,24 @@ module Spotted
31
31
 
32
32
  # @!attribute shows
33
33
  #
34
- # @return [Spotted::Models::SearchSearchResponse::Shows, nil]
35
- optional :shows, -> { Spotted::Models::SearchSearchResponse::Shows }
34
+ # @return [Spotted::Models::SearchQueryResponse::Shows, nil]
35
+ optional :shows, -> { Spotted::Models::SearchQueryResponse::Shows }
36
36
 
37
37
  # @!attribute tracks
38
38
  #
39
- # @return [Spotted::Models::SearchSearchResponse::Tracks, nil]
40
- optional :tracks, -> { Spotted::Models::SearchSearchResponse::Tracks }
39
+ # @return [Spotted::Models::SearchQueryResponse::Tracks, nil]
40
+ optional :tracks, -> { Spotted::Models::SearchQueryResponse::Tracks }
41
41
 
42
42
  # @!method initialize(albums: nil, artists: nil, audiobooks: nil, episodes: nil, playlists: nil, shows: nil, tracks: nil)
43
- # @param albums [Spotted::Models::SearchSearchResponse::Albums]
44
- # @param artists [Spotted::Models::SearchSearchResponse::Artists]
45
- # @param audiobooks [Spotted::Models::SearchSearchResponse::Audiobooks]
46
- # @param episodes [Spotted::Models::SearchSearchResponse::Episodes]
43
+ # @param albums [Spotted::Models::SearchQueryResponse::Albums]
44
+ # @param artists [Spotted::Models::SearchQueryResponse::Artists]
45
+ # @param audiobooks [Spotted::Models::SearchQueryResponse::Audiobooks]
46
+ # @param episodes [Spotted::Models::SearchQueryResponse::Episodes]
47
47
  # @param playlists [Spotted::Models::PagingPlaylistObject]
48
- # @param shows [Spotted::Models::SearchSearchResponse::Shows]
49
- # @param tracks [Spotted::Models::SearchSearchResponse::Tracks]
48
+ # @param shows [Spotted::Models::SearchQueryResponse::Shows]
49
+ # @param tracks [Spotted::Models::SearchQueryResponse::Tracks]
50
50
 
51
- # @see Spotted::Models::SearchSearchResponse#albums
51
+ # @see Spotted::Models::SearchQueryResponse#albums
52
52
  class Albums < Spotted::Internal::Type::BaseModel
53
53
  # @!attribute href
54
54
  # A link to the Web API endpoint returning the full result of the request
@@ -58,9 +58,9 @@ module Spotted
58
58
 
59
59
  # @!attribute items
60
60
  #
61
- # @return [Array<Spotted::Models::SearchSearchResponse::Albums::Item>]
61
+ # @return [Array<Spotted::Models::SearchQueryResponse::Albums::Item>]
62
62
  required :items,
63
- -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::SearchSearchResponse::Albums::Item] }
63
+ -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::SearchQueryResponse::Albums::Item] }
64
64
 
65
65
  # @!attribute limit
66
66
  # The maximum number of items in the response (as set in the query or by default).
@@ -94,11 +94,11 @@ module Spotted
94
94
 
95
95
  # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
96
96
  # Some parameter documentations has been truncated, see
97
- # {Spotted::Models::SearchSearchResponse::Albums} for more details.
97
+ # {Spotted::Models::SearchQueryResponse::Albums} for more details.
98
98
  #
99
99
  # @param href [String] A link to the Web API endpoint returning the full result of the request
100
100
  #
101
- # @param items [Array<Spotted::Models::SearchSearchResponse::Albums::Item>]
101
+ # @param items [Array<Spotted::Models::SearchQueryResponse::Albums::Item>]
102
102
  #
103
103
  # @param limit [Integer] The maximum number of items in the response (as set in the query or by default).
104
104
  #
@@ -121,8 +121,8 @@ module Spotted
121
121
  # @!attribute album_type
122
122
  # The type of the album.
123
123
  #
124
- # @return [Symbol, Spotted::Models::SearchSearchResponse::Albums::Item::AlbumType]
125
- required :album_type, enum: -> { Spotted::Models::SearchSearchResponse::Albums::Item::AlbumType }
124
+ # @return [Symbol, Spotted::Models::SearchQueryResponse::Albums::Item::AlbumType]
125
+ required :album_type, enum: -> { Spotted::Models::SearchQueryResponse::Albums::Item::AlbumType }
126
126
 
127
127
  # @!attribute artists
128
128
  # The artists of the album. Each artist object includes a link in `href` to more
@@ -174,9 +174,9 @@ module Spotted
174
174
  # @!attribute release_date_precision
175
175
  # The precision with which `release_date` value is known.
176
176
  #
177
- # @return [Symbol, Spotted::Models::SearchSearchResponse::Albums::Item::ReleaseDatePrecision]
177
+ # @return [Symbol, Spotted::Models::SearchQueryResponse::Albums::Item::ReleaseDatePrecision]
178
178
  required :release_date_precision,
179
- enum: -> { Spotted::Models::SearchSearchResponse::Albums::Item::ReleaseDatePrecision }
179
+ enum: -> { Spotted::Models::SearchQueryResponse::Albums::Item::ReleaseDatePrecision }
180
180
 
181
181
  # @!attribute total_tracks
182
182
  # The number of tracks in the album.
@@ -187,8 +187,8 @@ module Spotted
187
187
  # @!attribute type
188
188
  # The object type.
189
189
  #
190
- # @return [Symbol, Spotted::Models::SearchSearchResponse::Albums::Item::Type]
191
- required :type, enum: -> { Spotted::Models::SearchSearchResponse::Albums::Item::Type }
190
+ # @return [Symbol, Spotted::Models::SearchQueryResponse::Albums::Item::Type]
191
+ required :type, enum: -> { Spotted::Models::SearchQueryResponse::Albums::Item::Type }
192
192
 
193
193
  # @!attribute uri
194
194
  # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -205,11 +205,11 @@ module Spotted
205
205
 
206
206
  # @!method initialize(id:, album_type:, artists:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, type:, uri:, restrictions: nil)
207
207
  # Some parameter documentations has been truncated, see
208
- # {Spotted::Models::SearchSearchResponse::Albums::Item} for more details.
208
+ # {Spotted::Models::SearchQueryResponse::Albums::Item} for more details.
209
209
  #
210
210
  # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the album
211
211
  #
212
- # @param album_type [Symbol, Spotted::Models::SearchSearchResponse::Albums::Item::AlbumType] The type of the album.
212
+ # @param album_type [Symbol, Spotted::Models::SearchQueryResponse::Albums::Item::AlbumType] The type of the album.
213
213
  #
214
214
  # @param artists [Array<Spotted::Models::SimplifiedArtistObject>] The artists of the album. Each artist object includes a link in `href` to more d
215
215
  #
@@ -225,11 +225,11 @@ module Spotted
225
225
  #
226
226
  # @param release_date [String] The date the album was first released.
227
227
  #
228
- # @param release_date_precision [Symbol, Spotted::Models::SearchSearchResponse::Albums::Item::ReleaseDatePrecision] The precision with which `release_date` value is known.
228
+ # @param release_date_precision [Symbol, Spotted::Models::SearchQueryResponse::Albums::Item::ReleaseDatePrecision] The precision with which `release_date` value is known.
229
229
  #
230
230
  # @param total_tracks [Integer] The number of tracks in the album.
231
231
  #
232
- # @param type [Symbol, Spotted::Models::SearchSearchResponse::Albums::Item::Type] The object type.
232
+ # @param type [Symbol, Spotted::Models::SearchQueryResponse::Albums::Item::Type] The object type.
233
233
  #
234
234
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the albu
235
235
  #
@@ -237,7 +237,7 @@ module Spotted
237
237
 
238
238
  # The type of the album.
239
239
  #
240
- # @see Spotted::Models::SearchSearchResponse::Albums::Item#album_type
240
+ # @see Spotted::Models::SearchQueryResponse::Albums::Item#album_type
241
241
  module AlbumType
242
242
  extend Spotted::Internal::Type::Enum
243
243
 
@@ -251,7 +251,7 @@ module Spotted
251
251
 
252
252
  # The precision with which `release_date` value is known.
253
253
  #
254
- # @see Spotted::Models::SearchSearchResponse::Albums::Item#release_date_precision
254
+ # @see Spotted::Models::SearchQueryResponse::Albums::Item#release_date_precision
255
255
  module ReleaseDatePrecision
256
256
  extend Spotted::Internal::Type::Enum
257
257
 
@@ -265,7 +265,7 @@ module Spotted
265
265
 
266
266
  # The object type.
267
267
  #
268
- # @see Spotted::Models::SearchSearchResponse::Albums::Item#type
268
+ # @see Spotted::Models::SearchQueryResponse::Albums::Item#type
269
269
  module Type
270
270
  extend Spotted::Internal::Type::Enum
271
271
 
@@ -277,7 +277,7 @@ module Spotted
277
277
  end
278
278
  end
279
279
 
280
- # @see Spotted::Models::SearchSearchResponse#artists
280
+ # @see Spotted::Models::SearchQueryResponse#artists
281
281
  class Artists < Spotted::Internal::Type::BaseModel
282
282
  # @!attribute href
283
283
  # A link to the Web API endpoint returning the full result of the request
@@ -322,7 +322,7 @@ module Spotted
322
322
 
323
323
  # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
324
324
  # Some parameter documentations has been truncated, see
325
- # {Spotted::Models::SearchSearchResponse::Artists} for more details.
325
+ # {Spotted::Models::SearchQueryResponse::Artists} for more details.
326
326
  #
327
327
  # @param href [String] A link to the Web API endpoint returning the full result of the request
328
328
  #
@@ -339,7 +339,7 @@ module Spotted
339
339
  # @param total [Integer] The total number of items available to return.
340
340
  end
341
341
 
342
- # @see Spotted::Models::SearchSearchResponse#audiobooks
342
+ # @see Spotted::Models::SearchQueryResponse#audiobooks
343
343
  class Audiobooks < Spotted::Internal::Type::BaseModel
344
344
  # @!attribute href
345
345
  # A link to the Web API endpoint returning the full result of the request
@@ -384,7 +384,7 @@ module Spotted
384
384
 
385
385
  # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
386
386
  # Some parameter documentations has been truncated, see
387
- # {Spotted::Models::SearchSearchResponse::Audiobooks} for more details.
387
+ # {Spotted::Models::SearchQueryResponse::Audiobooks} for more details.
388
388
  #
389
389
  # @param href [String] A link to the Web API endpoint returning the full result of the request
390
390
  #
@@ -401,7 +401,7 @@ module Spotted
401
401
  # @param total [Integer] The total number of items available to return.
402
402
  end
403
403
 
404
- # @see Spotted::Models::SearchSearchResponse#episodes
404
+ # @see Spotted::Models::SearchQueryResponse#episodes
405
405
  class Episodes < Spotted::Internal::Type::BaseModel
406
406
  # @!attribute href
407
407
  # A link to the Web API endpoint returning the full result of the request
@@ -446,7 +446,7 @@ module Spotted
446
446
 
447
447
  # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
448
448
  # Some parameter documentations has been truncated, see
449
- # {Spotted::Models::SearchSearchResponse::Episodes} for more details.
449
+ # {Spotted::Models::SearchQueryResponse::Episodes} for more details.
450
450
  #
451
451
  # @param href [String] A link to the Web API endpoint returning the full result of the request
452
452
  #
@@ -463,7 +463,7 @@ module Spotted
463
463
  # @param total [Integer] The total number of items available to return.
464
464
  end
465
465
 
466
- # @see Spotted::Models::SearchSearchResponse#shows
466
+ # @see Spotted::Models::SearchQueryResponse#shows
467
467
  class Shows < Spotted::Internal::Type::BaseModel
468
468
  # @!attribute href
469
469
  # A link to the Web API endpoint returning the full result of the request
@@ -508,7 +508,7 @@ module Spotted
508
508
 
509
509
  # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
510
510
  # Some parameter documentations has been truncated, see
511
- # {Spotted::Models::SearchSearchResponse::Shows} for more details.
511
+ # {Spotted::Models::SearchQueryResponse::Shows} for more details.
512
512
  #
513
513
  # @param href [String] A link to the Web API endpoint returning the full result of the request
514
514
  #
@@ -525,7 +525,7 @@ module Spotted
525
525
  # @param total [Integer] The total number of items available to return.
526
526
  end
527
527
 
528
- # @see Spotted::Models::SearchSearchResponse#tracks
528
+ # @see Spotted::Models::SearchQueryResponse#tracks
529
529
  class Tracks < Spotted::Internal::Type::BaseModel
530
530
  # @!attribute href
531
531
  # A link to the Web API endpoint returning the full result of the request
@@ -570,7 +570,7 @@ module Spotted
570
570
 
571
571
  # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
572
572
  # Some parameter documentations has been truncated, see
573
- # {Spotted::Models::SearchSearchResponse::Tracks} for more details.
573
+ # {Spotted::Models::SearchQueryResponse::Tracks} for more details.
574
574
  #
575
575
  # @param href [String] A link to the Web API endpoint returning the full result of the request
576
576
  #
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Shows#list
6
- class ShowListParams < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Shows#bulk_retrieve
6
+ class ShowBulkRetrieveParams < Spotted::Internal::Type::BaseModel
7
7
  extend Spotted::Internal::Type::RequestParameters::Converter
8
8
  include Spotted::Internal::Type::RequestParameters
9
9
 
@@ -31,7 +31,7 @@ module Spotted
31
31
 
32
32
  # @!method initialize(ids:, market: nil, request_options: {})
33
33
  # Some parameter documentations has been truncated, see
34
- # {Spotted::Models::ShowListParams} for more details.
34
+ # {Spotted::Models::ShowBulkRetrieveParams} for more details.
35
35
  #
36
36
  # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
37
37
  #
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Shows#list
6
- class ShowListResponse < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Shows#bulk_retrieve
6
+ class ShowBulkRetrieveResponse < Spotted::Internal::Type::BaseModel
7
7
  # @!attribute shows
8
8
  #
9
9
  # @return [Array<Spotted::Models::ShowBase>]
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Tracks#list
6
- class TrackListParams < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Tracks#bulk_retrieve
6
+ class TrackBulkRetrieveParams < Spotted::Internal::Type::BaseModel
7
7
  extend Spotted::Internal::Type::RequestParameters::Converter
8
8
  include Spotted::Internal::Type::RequestParameters
9
9
 
@@ -31,7 +31,7 @@ module Spotted
31
31
 
32
32
  # @!method initialize(ids:, market: nil, request_options: {})
33
33
  # Some parameter documentations has been truncated, see
34
- # {Spotted::Models::TrackListParams} for more details.
34
+ # {Spotted::Models::TrackBulkRetrieveParams} for more details.
35
35
  #
36
36
  # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
37
37
  #
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Artists#list_top_tracks
6
- class ArtistListTopTracksResponse < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Tracks#bulk_retrieve
6
+ class TrackBulkRetrieveResponse < Spotted::Internal::Type::BaseModel
7
7
  # @!attribute tracks
8
8
  #
9
9
  # @return [Array<Spotted::Models::TrackObject>]
@@ -47,29 +47,29 @@ module Spotted
47
47
 
48
48
  AlbumRetrieveParams = Spotted::Models::AlbumRetrieveParams
49
49
 
50
- ArtistListAlbumsParams = Spotted::Models::ArtistListAlbumsParams
50
+ ArtistBulkRetrieveParams = Spotted::Models::ArtistBulkRetrieveParams
51
51
 
52
- ArtistListParams = Spotted::Models::ArtistListParams
52
+ ArtistListAlbumsParams = Spotted::Models::ArtistListAlbumsParams
53
53
 
54
54
  ArtistListRelatedArtistsParams = Spotted::Models::ArtistListRelatedArtistsParams
55
55
 
56
- ArtistListTopTracksParams = Spotted::Models::ArtistListTopTracksParams
57
-
58
56
  ArtistObject = Spotted::Models::ArtistObject
59
57
 
60
58
  ArtistRetrieveParams = Spotted::Models::ArtistRetrieveParams
61
59
 
60
+ ArtistTopTracksParams = Spotted::Models::ArtistTopTracksParams
61
+
62
62
  AudioAnalysisRetrieveParams = Spotted::Models::AudioAnalysisRetrieveParams
63
63
 
64
64
  AudiobookBase = Spotted::Models::AudiobookBase
65
65
 
66
- AudiobookListChaptersParams = Spotted::Models::AudiobookListChaptersParams
66
+ AudiobookBulkRetrieveParams = Spotted::Models::AudiobookBulkRetrieveParams
67
67
 
68
- AudiobookListParams = Spotted::Models::AudiobookListParams
68
+ AudiobookListChaptersParams = Spotted::Models::AudiobookListChaptersParams
69
69
 
70
70
  AudiobookRetrieveParams = Spotted::Models::AudiobookRetrieveParams
71
71
 
72
- AudioFeatureListParams = Spotted::Models::AudioFeatureListParams
72
+ AudioFeatureBulkRetrieveParams = Spotted::Models::AudioFeatureBulkRetrieveParams
73
73
 
74
74
  AudioFeatureRetrieveParams = Spotted::Models::AudioFeatureRetrieveParams
75
75
 
@@ -81,7 +81,7 @@ module Spotted
81
81
 
82
82
  BrowseGetNewReleasesParams = Spotted::Models::BrowseGetNewReleasesParams
83
83
 
84
- ChapterListParams = Spotted::Models::ChapterListParams
84
+ ChapterBulkRetrieveParams = Spotted::Models::ChapterBulkRetrieveParams
85
85
 
86
86
  ChapterRestrictionObject = Spotted::Models::ChapterRestrictionObject
87
87
 
@@ -89,7 +89,7 @@ module Spotted
89
89
 
90
90
  CopyrightObject = Spotted::Models::CopyrightObject
91
91
 
92
- EpisodeListParams = Spotted::Models::EpisodeListParams
92
+ EpisodeBulkRetrieveParams = Spotted::Models::EpisodeBulkRetrieveParams
93
93
 
94
94
  EpisodeObject = Spotted::Models::EpisodeObject
95
95
 
@@ -136,13 +136,13 @@ module Spotted
136
136
 
137
137
  ResumePointObject = Spotted::Models::ResumePointObject
138
138
 
139
- SearchSearchParams = Spotted::Models::SearchSearchParams
139
+ SearchQueryParams = Spotted::Models::SearchQueryParams
140
140
 
141
141
  ShowBase = Spotted::Models::ShowBase
142
142
 
143
- ShowListEpisodesParams = Spotted::Models::ShowListEpisodesParams
143
+ ShowBulkRetrieveParams = Spotted::Models::ShowBulkRetrieveParams
144
144
 
145
- ShowListParams = Spotted::Models::ShowListParams
145
+ ShowListEpisodesParams = Spotted::Models::ShowListEpisodesParams
146
146
 
147
147
  ShowRetrieveParams = Spotted::Models::ShowRetrieveParams
148
148
 
@@ -158,7 +158,7 @@ module Spotted
158
158
 
159
159
  TimeIntervalObject = Spotted::Models::TimeIntervalObject
160
160
 
161
- TrackListParams = Spotted::Models::TrackListParams
161
+ TrackBulkRetrieveParams = Spotted::Models::TrackBulkRetrieveParams
162
162
 
163
163
  TrackObject = Spotted::Models::TrackObject
164
164
 
@@ -28,26 +28,26 @@ module Spotted
28
28
  end
29
29
 
30
30
  # Some parameter documentations has been truncated, see
31
- # {Spotted::Models::ArtistListParams} for more details.
31
+ # {Spotted::Models::ArtistBulkRetrieveParams} for more details.
32
32
  #
33
33
  # Get Spotify catalog information for several artists based on their Spotify IDs.
34
34
  #
35
- # @overload list(ids:, request_options: {})
35
+ # @overload bulk_retrieve(ids:, request_options: {})
36
36
  #
37
37
  # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
38
38
  #
39
39
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
40
40
  #
41
- # @return [Spotted::Models::ArtistListResponse]
41
+ # @return [Spotted::Models::ArtistBulkRetrieveResponse]
42
42
  #
43
- # @see Spotted::Models::ArtistListParams
44
- def list(params)
45
- parsed, options = Spotted::ArtistListParams.dump_request(params)
43
+ # @see Spotted::Models::ArtistBulkRetrieveParams
44
+ def bulk_retrieve(params)
45
+ parsed, options = Spotted::ArtistBulkRetrieveParams.dump_request(params)
46
46
  @client.request(
47
47
  method: :get,
48
48
  path: "artists",
49
49
  query: parsed,
50
- model: Spotted::Models::ArtistListResponse,
50
+ model: Spotted::Models::ArtistBulkRetrieveResponse,
51
51
  options: options
52
52
  )
53
53
  end
@@ -113,11 +113,11 @@ module Spotted
113
113
  end
114
114
 
115
115
  # Some parameter documentations has been truncated, see
116
- # {Spotted::Models::ArtistListTopTracksParams} for more details.
116
+ # {Spotted::Models::ArtistTopTracksParams} for more details.
117
117
  #
118
118
  # Get Spotify catalog information about an artist's top tracks by country.
119
119
  #
120
- # @overload list_top_tracks(id, market: nil, request_options: {})
120
+ # @overload top_tracks(id, market: nil, request_options: {})
121
121
  #
122
122
  # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the artist
123
123
  #
@@ -125,16 +125,16 @@ module Spotted
125
125
  #
126
126
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
127
127
  #
128
- # @return [Spotted::Models::ArtistListTopTracksResponse]
128
+ # @return [Spotted::Models::ArtistTopTracksResponse]
129
129
  #
130
- # @see Spotted::Models::ArtistListTopTracksParams
131
- def list_top_tracks(id, params = {})
132
- parsed, options = Spotted::ArtistListTopTracksParams.dump_request(params)
130
+ # @see Spotted::Models::ArtistTopTracksParams
131
+ def top_tracks(id, params = {})
132
+ parsed, options = Spotted::ArtistTopTracksParams.dump_request(params)
133
133
  @client.request(
134
134
  method: :get,
135
135
  path: ["artists/%1$s/top-tracks", id],
136
136
  query: parsed,
137
- model: Spotted::Models::ArtistListTopTracksResponse,
137
+ model: Spotted::Models::ArtistTopTracksResponse,
138
138
  options: options
139
139
  )
140
140
  end
@@ -32,26 +32,26 @@ module Spotted
32
32
  # @deprecated
33
33
  #
34
34
  # Some parameter documentations has been truncated, see
35
- # {Spotted::Models::AudioFeatureListParams} for more details.
35
+ # {Spotted::Models::AudioFeatureBulkRetrieveParams} for more details.
36
36
  #
37
37
  # Get audio features for multiple tracks based on their Spotify IDs.
38
38
  #
39
- # @overload list(ids:, request_options: {})
39
+ # @overload bulk_retrieve(ids:, request_options: {})
40
40
  #
41
41
  # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
42
42
  #
43
43
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
44
44
  #
45
- # @return [Spotted::Models::AudioFeatureListResponse]
45
+ # @return [Spotted::Models::AudioFeatureBulkRetrieveResponse]
46
46
  #
47
- # @see Spotted::Models::AudioFeatureListParams
48
- def list(params)
49
- parsed, options = Spotted::AudioFeatureListParams.dump_request(params)
47
+ # @see Spotted::Models::AudioFeatureBulkRetrieveParams
48
+ def bulk_retrieve(params)
49
+ parsed, options = Spotted::AudioFeatureBulkRetrieveParams.dump_request(params)
50
50
  @client.request(
51
51
  method: :get,
52
52
  path: "audio-features",
53
53
  query: parsed,
54
- model: Spotted::Models::AudioFeatureListResponse,
54
+ model: Spotted::Models::AudioFeatureBulkRetrieveResponse,
55
55
  options: options
56
56
  )
57
57
  end
@@ -32,13 +32,13 @@ module Spotted
32
32
  end
33
33
 
34
34
  # Some parameter documentations has been truncated, see
35
- # {Spotted::Models::AudiobookListParams} for more details.
35
+ # {Spotted::Models::AudiobookBulkRetrieveParams} for more details.
36
36
  #
37
37
  # Get Spotify catalog information for several audiobooks identified by their
38
38
  # Spotify IDs. Audiobooks are only available within the US, UK, Canada, Ireland,
39
39
  # New Zealand and Australia markets.
40
40
  #
41
- # @overload list(ids:, market: nil, request_options: {})
41
+ # @overload bulk_retrieve(ids:, market: nil, request_options: {})
42
42
  #
43
43
  # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
44
44
  #
@@ -46,16 +46,16 @@ module Spotted
46
46
  #
47
47
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
48
48
  #
49
- # @return [Spotted::Models::AudiobookListResponse]
49
+ # @return [Spotted::Models::AudiobookBulkRetrieveResponse]
50
50
  #
51
- # @see Spotted::Models::AudiobookListParams
52
- def list(params)
53
- parsed, options = Spotted::AudiobookListParams.dump_request(params)
51
+ # @see Spotted::Models::AudiobookBulkRetrieveParams
52
+ def bulk_retrieve(params)
53
+ parsed, options = Spotted::AudiobookBulkRetrieveParams.dump_request(params)
54
54
  @client.request(
55
55
  method: :get,
56
56
  path: "audiobooks",
57
57
  query: parsed,
58
- model: Spotted::Models::AudiobookListResponse,
58
+ model: Spotted::Models::AudiobookBulkRetrieveResponse,
59
59
  options: options
60
60
  )
61
61
  end
@@ -33,13 +33,13 @@ module Spotted
33
33
  end
34
34
 
35
35
  # Some parameter documentations has been truncated, see
36
- # {Spotted::Models::ChapterListParams} for more details.
36
+ # {Spotted::Models::ChapterBulkRetrieveParams} for more details.
37
37
  #
38
38
  # Get Spotify catalog information for several audiobook chapters identified by
39
39
  # their Spotify IDs. Chapters are only available within the US, UK, Canada,
40
40
  # Ireland, New Zealand and Australia markets.
41
41
  #
42
- # @overload list(ids:, market: nil, request_options: {})
42
+ # @overload bulk_retrieve(ids:, market: nil, request_options: {})
43
43
  #
44
44
  # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
45
45
  #
@@ -47,16 +47,16 @@ module Spotted
47
47
  #
48
48
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
49
49
  #
50
- # @return [Spotted::Models::ChapterListResponse]
50
+ # @return [Spotted::Models::ChapterBulkRetrieveResponse]
51
51
  #
52
- # @see Spotted::Models::ChapterListParams
53
- def list(params)
54
- parsed, options = Spotted::ChapterListParams.dump_request(params)
52
+ # @see Spotted::Models::ChapterBulkRetrieveParams
53
+ def bulk_retrieve(params)
54
+ parsed, options = Spotted::ChapterBulkRetrieveParams.dump_request(params)
55
55
  @client.request(
56
56
  method: :get,
57
57
  path: "chapters",
58
58
  query: parsed,
59
- model: Spotted::Models::ChapterListResponse,
59
+ model: Spotted::Models::ChapterBulkRetrieveResponse,
60
60
  options: options
61
61
  )
62
62
  end
@@ -32,11 +32,11 @@ module Spotted
32
32
  end
33
33
 
34
34
  # Some parameter documentations has been truncated, see
35
- # {Spotted::Models::EpisodeListParams} for more details.
35
+ # {Spotted::Models::EpisodeBulkRetrieveParams} for more details.
36
36
  #
37
37
  # Get Spotify catalog information for several episodes based on their Spotify IDs.
38
38
  #
39
- # @overload list(ids:, market: nil, request_options: {})
39
+ # @overload bulk_retrieve(ids:, market: nil, request_options: {})
40
40
  #
41
41
  # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
42
42
  #
@@ -44,16 +44,16 @@ module Spotted
44
44
  #
45
45
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
46
46
  #
47
- # @return [Spotted::Models::EpisodeListResponse]
47
+ # @return [Spotted::Models::EpisodeBulkRetrieveResponse]
48
48
  #
49
- # @see Spotted::Models::EpisodeListParams
50
- def list(params)
51
- parsed, options = Spotted::EpisodeListParams.dump_request(params)
49
+ # @see Spotted::Models::EpisodeBulkRetrieveParams
50
+ def bulk_retrieve(params)
51
+ parsed, options = Spotted::EpisodeBulkRetrieveParams.dump_request(params)
52
52
  @client.request(
53
53
  method: :get,
54
54
  path: "episodes",
55
55
  query: parsed,
56
- model: Spotted::Models::EpisodeListResponse,
56
+ model: Spotted::Models::EpisodeBulkRetrieveResponse,
57
57
  options: options
58
58
  )
59
59
  end