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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 69011802cc24ebf07c3e3d147833884b4ed56bb7237c0fd6da89c0206ffd58c3
4
- data.tar.gz: 17fb6b912a0ec3914a5ff7f1921a0411eaf5b04d325c45e78f709bf6b1e59d71
3
+ metadata.gz: af077c728fe204cc5fda22ae070754b27a2e4355184b059bd85a5edf1548885a
4
+ data.tar.gz: 0f5c5e2ea9e445b2d49b6c71b40f6672dab9d2d89e7e27b9ca9b1b581983c90b
5
5
  SHA512:
6
- metadata.gz: 546c738d922c2d58202bad6bc2b87f1f0a98ed6bf6b3304dda7bbd824e096fcf50a00ac0261b9eb7b3854c9a62b8eb80f81ba5f31d6a92d52e7afad0e155c35d
7
- data.tar.gz: b73b1d99987f83e64182ffbb4a45e5ee9e8abab95ae7973cdeb186ca32850d4e2dc946a9100d99602f784bc6d196aaae9453773c805b744fda85444a7ef9c4f7
6
+ metadata.gz: 98ec3a3dad684fe4328272169de4863f38ccd305a5fcacee42f12d9934e9e985ae94953281601bf6f9fdc47258b00e566ba8b23f2baf6c4fefa08cee61b3ab19
7
+ data.tar.gz: 01aec0e6dcc2dd12eb5984094784a80f3b92bf6da95272337191e21bb4faa6b5b1362f1792c4e429f13fe58e556576559742d64820098598e34c1122ad784b4c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.9.0 (2025-11-10)
4
+
5
+ Full Changelog: [v0.8.0...v0.9.0](https://github.com/cjavdev/spotted/compare/v0.8.0...v0.9.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** manual updates ([d7059d0](https://github.com/cjavdev/spotted/commit/d7059d0b67ffd498ea79c2a3322a203759679eef))
10
+ * **api:** manual updates ([08b7c1c](https://github.com/cjavdev/spotted/commit/08b7c1c5f32b6ddee5a19f902578403b574d9057))
11
+ * **api:** manual updates ([bc5c542](https://github.com/cjavdev/spotted/commit/bc5c5426c61c72b5ced96ea90fce4753660b2def))
12
+ * **api:** manual updates ([283529b](https://github.com/cjavdev/spotted/commit/283529b11d5c51164d4387c4c30a642760278bf3))
13
+
3
14
  ## 0.8.0 (2025-11-10)
4
15
 
5
16
  Full Changelog: [v0.7.0...v0.8.0](https://github.com/cjavdev/spotted/compare/v0.7.0...v0.8.0)
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "spotted", "~> 0.8.0"
20
+ gem "spotted", "~> 0.9.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -38,6 +38,34 @@ album = spotted.albums.retrieve("4aawyAB9vmqN3uQ7FjRGTy")
38
38
  puts(album.id)
39
39
  ```
40
40
 
41
+ ### Pagination
42
+
43
+ List methods in the Spotted API are paginated.
44
+
45
+ This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
46
+
47
+ ```ruby
48
+ page = spotted.shows.list_episodes("showid", limit: 5, offset: 10)
49
+
50
+ # Fetch single item from page.
51
+ show = page.items[0]
52
+ puts(show.id)
53
+
54
+ # Automatically fetches more pages as needed.
55
+ page.auto_paging_each do |show|
56
+ puts(show.id)
57
+ end
58
+ ```
59
+
60
+ Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
61
+
62
+ ```ruby
63
+ if page.next_page?
64
+ new_page = page.next_page
65
+ puts(new_page.items[0].id)
66
+ end
67
+ ```
68
+
41
69
  ### Handling errors
42
70
 
43
71
  When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Spotted::Errors::APIError` will be thrown:
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Artists#list
6
- class ArtistListParams < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Artists#bulk_retrieve
6
+ class ArtistBulkRetrieveParams < Spotted::Internal::Type::BaseModel
7
7
  extend Spotted::Internal::Type::RequestParameters::Converter
8
8
  include Spotted::Internal::Type::RequestParameters
9
9
 
@@ -17,7 +17,7 @@ module Spotted
17
17
 
18
18
  # @!method initialize(ids:, request_options: {})
19
19
  # Some parameter documentations has been truncated, see
20
- # {Spotted::Models::ArtistListParams} for more details.
20
+ # {Spotted::Models::ArtistBulkRetrieveParams} for more details.
21
21
  #
22
22
  # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
23
23
  #
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Artists#list
6
- class ArtistListResponse < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Artists#bulk_retrieve
6
+ class ArtistBulkRetrieveResponse < Spotted::Internal::Type::BaseModel
7
7
  # @!attribute artists
8
8
  #
9
9
  # @return [Array<Spotted::Models::ArtistObject>]
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Artists#list_top_tracks
6
- class ArtistListTopTracksParams < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Artists#top_tracks
6
+ class ArtistTopTracksParams < Spotted::Internal::Type::BaseModel
7
7
  extend Spotted::Internal::Type::RequestParameters::Converter
8
8
  include Spotted::Internal::Type::RequestParameters
9
9
 
@@ -23,7 +23,7 @@ module Spotted
23
23
 
24
24
  # @!method initialize(market: nil, request_options: {})
25
25
  # Some parameter documentations has been truncated, see
26
- # {Spotted::Models::ArtistListTopTracksParams} for more details.
26
+ # {Spotted::Models::ArtistTopTracksParams} for more details.
27
27
  #
28
28
  # @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
29
29
  #
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Tracks#list
6
- class TrackListResponse < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Artists#top_tracks
6
+ class ArtistTopTracksResponse < Spotted::Internal::Type::BaseModel
7
7
  # @!attribute tracks
8
8
  #
9
9
  # @return [Array<Spotted::Models::TrackObject>]
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::AudioFeatures#list
6
- class AudioFeatureListParams < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::AudioFeatures#bulk_retrieve
6
+ class AudioFeatureBulkRetrieveParams < Spotted::Internal::Type::BaseModel
7
7
  extend Spotted::Internal::Type::RequestParameters::Converter
8
8
  include Spotted::Internal::Type::RequestParameters
9
9
 
@@ -17,7 +17,7 @@ module Spotted
17
17
 
18
18
  # @!method initialize(ids:, request_options: {})
19
19
  # Some parameter documentations has been truncated, see
20
- # {Spotted::Models::AudioFeatureListParams} for more details.
20
+ # {Spotted::Models::AudioFeatureBulkRetrieveParams} for more details.
21
21
  #
22
22
  # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
23
23
  #
@@ -2,16 +2,16 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::AudioFeatures#list
6
- class AudioFeatureListResponse < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::AudioFeatures#bulk_retrieve
6
+ class AudioFeatureBulkRetrieveResponse < Spotted::Internal::Type::BaseModel
7
7
  # @!attribute audio_features
8
8
  #
9
- # @return [Array<Spotted::Models::AudioFeatureListResponse::AudioFeature>]
9
+ # @return [Array<Spotted::Models::AudioFeatureBulkRetrieveResponse::AudioFeature>]
10
10
  required :audio_features,
11
- -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::AudioFeatureListResponse::AudioFeature] }
11
+ -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::AudioFeatureBulkRetrieveResponse::AudioFeature] }
12
12
 
13
13
  # @!method initialize(audio_features:)
14
- # @param audio_features [Array<Spotted::Models::AudioFeatureListResponse::AudioFeature>]
14
+ # @param audio_features [Array<Spotted::Models::AudioFeatureBulkRetrieveResponse::AudioFeature>]
15
15
 
16
16
  class AudioFeature < Spotted::Internal::Type::BaseModel
17
17
  # @!attribute id
@@ -139,8 +139,8 @@ module Spotted
139
139
  # @!attribute type
140
140
  # The object type.
141
141
  #
142
- # @return [Symbol, Spotted::Models::AudioFeatureListResponse::AudioFeature::Type, nil]
143
- optional :type, enum: -> { Spotted::Models::AudioFeatureListResponse::AudioFeature::Type }
142
+ # @return [Symbol, Spotted::Models::AudioFeatureBulkRetrieveResponse::AudioFeature::Type, nil]
143
+ optional :type, enum: -> { Spotted::Models::AudioFeatureBulkRetrieveResponse::AudioFeature::Type }
144
144
 
145
145
  # @!attribute uri
146
146
  # The Spotify URI for the track.
@@ -159,7 +159,8 @@ module Spotted
159
159
 
160
160
  # @!method initialize(id: nil, acousticness: nil, analysis_url: nil, danceability: nil, duration_ms: nil, energy: nil, instrumentalness: nil, key: nil, liveness: nil, loudness: nil, mode: nil, speechiness: nil, tempo: nil, time_signature: nil, track_href: nil, type: nil, uri: nil, valence: nil)
161
161
  # Some parameter documentations has been truncated, see
162
- # {Spotted::Models::AudioFeatureListResponse::AudioFeature} for more details.
162
+ # {Spotted::Models::AudioFeatureBulkRetrieveResponse::AudioFeature} for more
163
+ # details.
163
164
  #
164
165
  # @param id [String] The Spotify ID for the track.
165
166
  #
@@ -191,7 +192,7 @@ module Spotted
191
192
  #
192
193
  # @param track_href [String] A link to the Web API endpoint providing full details of the track.
193
194
  #
194
- # @param type [Symbol, Spotted::Models::AudioFeatureListResponse::AudioFeature::Type] The object type.
195
+ # @param type [Symbol, Spotted::Models::AudioFeatureBulkRetrieveResponse::AudioFeature::Type] The object type.
195
196
  #
196
197
  # @param uri [String] The Spotify URI for the track.
197
198
  #
@@ -199,7 +200,7 @@ module Spotted
199
200
 
200
201
  # The object type.
201
202
  #
202
- # @see Spotted::Models::AudioFeatureListResponse::AudioFeature#type
203
+ # @see Spotted::Models::AudioFeatureBulkRetrieveResponse::AudioFeature#type
203
204
  module Type
204
205
  extend Spotted::Internal::Type::Enum
205
206
 
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Audiobooks#list
6
- class AudiobookListParams < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Audiobooks#bulk_retrieve
6
+ class AudiobookBulkRetrieveParams < 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::AudiobookListParams} for more details.
34
+ # {Spotted::Models::AudiobookBulkRetrieveParams} 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,29 +2,29 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Audiobooks#list
6
- class AudiobookListResponse < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Audiobooks#bulk_retrieve
6
+ class AudiobookBulkRetrieveResponse < Spotted::Internal::Type::BaseModel
7
7
  # @!attribute audiobooks
8
8
  #
9
- # @return [Array<Spotted::Models::AudiobookListResponse::Audiobook>]
9
+ # @return [Array<Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook>]
10
10
  required :audiobooks,
11
- -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::AudiobookListResponse::Audiobook] }
11
+ -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook] }
12
12
 
13
13
  # @!method initialize(audiobooks:)
14
- # @param audiobooks [Array<Spotted::Models::AudiobookListResponse::Audiobook>]
14
+ # @param audiobooks [Array<Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook>]
15
15
 
16
16
  class Audiobook < Spotted::Models::AudiobookBase
17
17
  # @!attribute chapters
18
18
  # The chapters of the audiobook.
19
19
  #
20
- # @return [Spotted::Models::AudiobookListResponse::Audiobook::Chapters]
21
- required :chapters, -> { Spotted::Models::AudiobookListResponse::Audiobook::Chapters }
20
+ # @return [Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters]
21
+ required :chapters, -> { Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters }
22
22
 
23
23
  # @!method initialize(chapters:)
24
24
  # Some parameter documentations has been truncated, see
25
- # {Spotted::Models::AudiobookListResponse::Audiobook} for more details.
25
+ # {Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook} for more details.
26
26
  #
27
- # @param chapters [Spotted::Models::AudiobookListResponse::Audiobook::Chapters] The chapters of the audiobook.
27
+ # @param chapters [Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters] The chapters of the audiobook.
28
28
 
29
29
  class Chapters < Spotted::Internal::Type::BaseModel
30
30
  # @!attribute href
@@ -70,7 +70,8 @@ module Spotted
70
70
 
71
71
  # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
72
72
  # Some parameter documentations has been truncated, see
73
- # {Spotted::Models::AudiobookListResponse::Audiobook::Chapters} for more details.
73
+ # {Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters} for more
74
+ # details.
74
75
  #
75
76
  # The chapters of the audiobook.
76
77
  #
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Chapters#list
6
- class ChapterListParams < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Chapters#bulk_retrieve
6
+ class ChapterBulkRetrieveParams < 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::ChapterListParams} for more details.
34
+ # {Spotted::Models::ChapterBulkRetrieveParams} 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,15 +2,16 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Chapters#list
6
- class ChapterListResponse < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Chapters#bulk_retrieve
6
+ class ChapterBulkRetrieveResponse < Spotted::Internal::Type::BaseModel
7
7
  # @!attribute chapters
8
8
  #
9
- # @return [Array<Spotted::Models::ChapterListResponse::Chapter>]
10
- required :chapters, -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::ChapterListResponse::Chapter] }
9
+ # @return [Array<Spotted::Models::ChapterBulkRetrieveResponse::Chapter>]
10
+ required :chapters,
11
+ -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::ChapterBulkRetrieveResponse::Chapter] }
11
12
 
12
13
  # @!method initialize(chapters:)
13
- # @param chapters [Array<Spotted::Models::ChapterListResponse::Chapter>]
14
+ # @param chapters [Array<Spotted::Models::ChapterBulkRetrieveResponse::Chapter>]
14
15
 
15
16
  class Chapter < Spotted::Internal::Type::BaseModel
16
17
  # @!attribute id
@@ -114,15 +115,15 @@ module Spotted
114
115
  # @!attribute release_date_precision
115
116
  # The precision with which `release_date` value is known.
116
117
  #
117
- # @return [Symbol, Spotted::Models::ChapterListResponse::Chapter::ReleaseDatePrecision]
118
+ # @return [Symbol, Spotted::Models::ChapterBulkRetrieveResponse::Chapter::ReleaseDatePrecision]
118
119
  required :release_date_precision,
119
- enum: -> { Spotted::Models::ChapterListResponse::Chapter::ReleaseDatePrecision }
120
+ enum: -> { Spotted::Models::ChapterBulkRetrieveResponse::Chapter::ReleaseDatePrecision }
120
121
 
121
122
  # @!attribute type
122
123
  # The object type.
123
124
  #
124
- # @return [Symbol, Spotted::Models::ChapterListResponse::Chapter::Type]
125
- required :type, enum: -> { Spotted::Models::ChapterListResponse::Chapter::Type }
125
+ # @return [Symbol, Spotted::Models::ChapterBulkRetrieveResponse::Chapter::Type]
126
+ required :type, enum: -> { Spotted::Models::ChapterBulkRetrieveResponse::Chapter::Type }
126
127
 
127
128
  # @!attribute uri
128
129
  # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -153,7 +154,7 @@ module Spotted
153
154
 
154
155
  # @!method initialize(id:, audio_preview_url:, audiobook:, chapter_number:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_playable:, languages:, name:, release_date:, release_date_precision:, type:, uri:, available_markets: nil, restrictions: nil, resume_point: nil)
155
156
  # Some parameter documentations has been truncated, see
156
- # {Spotted::Models::ChapterListResponse::Chapter} for more details.
157
+ # {Spotted::Models::ChapterBulkRetrieveResponse::Chapter} for more details.
157
158
  #
158
159
  # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the chapt
159
160
  #
@@ -185,9 +186,9 @@ module Spotted
185
186
  #
186
187
  # @param release_date [String] The date the chapter was first released, for example `"1981-12-15"`. Depending o
187
188
  #
188
- # @param release_date_precision [Symbol, Spotted::Models::ChapterListResponse::Chapter::ReleaseDatePrecision] The precision with which `release_date` value is known.
189
+ # @param release_date_precision [Symbol, Spotted::Models::ChapterBulkRetrieveResponse::Chapter::ReleaseDatePrecision] The precision with which `release_date` value is known.
189
190
  #
190
- # @param type [Symbol, Spotted::Models::ChapterListResponse::Chapter::Type] The object type.
191
+ # @param type [Symbol, Spotted::Models::ChapterBulkRetrieveResponse::Chapter::Type] The object type.
191
192
  #
192
193
  # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the chap
193
194
  #
@@ -199,7 +200,7 @@ module Spotted
199
200
 
200
201
  # The precision with which `release_date` value is known.
201
202
  #
202
- # @see Spotted::Models::ChapterListResponse::Chapter#release_date_precision
203
+ # @see Spotted::Models::ChapterBulkRetrieveResponse::Chapter#release_date_precision
203
204
  module ReleaseDatePrecision
204
205
  extend Spotted::Internal::Type::Enum
205
206
 
@@ -213,7 +214,7 @@ module Spotted
213
214
 
214
215
  # The object type.
215
216
  #
216
- # @see Spotted::Models::ChapterListResponse::Chapter#type
217
+ # @see Spotted::Models::ChapterBulkRetrieveResponse::Chapter#type
217
218
  module Type
218
219
  extend Spotted::Internal::Type::Enum
219
220
 
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Episodes#list
6
- class EpisodeListParams < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Episodes#bulk_retrieve
6
+ class EpisodeBulkRetrieveParams < 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::EpisodeListParams} for more details.
34
+ # {Spotted::Models::EpisodeBulkRetrieveParams} 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::Episodes#list
6
- class EpisodeListResponse < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Episodes#bulk_retrieve
6
+ class EpisodeBulkRetrieveResponse < Spotted::Internal::Type::BaseModel
7
7
  # @!attribute episodes
8
8
  #
9
9
  # @return [Array<Spotted::Models::EpisodeObject>]
@@ -3,16 +3,16 @@
3
3
  module Spotted
4
4
  module Models
5
5
  module Me
6
- # @see Spotted::Resources::Me::Following#list
7
- class FollowingListParams < Spotted::Internal::Type::BaseModel
6
+ # @see Spotted::Resources::Me::Following#bulk_retrieve
7
+ class FollowingBulkRetrieveParams < Spotted::Internal::Type::BaseModel
8
8
  extend Spotted::Internal::Type::RequestParameters::Converter
9
9
  include Spotted::Internal::Type::RequestParameters
10
10
 
11
11
  # @!attribute type
12
12
  # The ID type: currently only `artist` is supported.
13
13
  #
14
- # @return [Symbol, Spotted::Models::Me::FollowingListParams::Type]
15
- required :type, enum: -> { Spotted::Me::FollowingListParams::Type }
14
+ # @return [Symbol, Spotted::Models::Me::FollowingBulkRetrieveParams::Type]
15
+ required :type, enum: -> { Spotted::Me::FollowingBulkRetrieveParams::Type }
16
16
 
17
17
  # @!attribute after
18
18
  # The last artist ID retrieved from the previous request.
@@ -28,9 +28,9 @@ module Spotted
28
28
 
29
29
  # @!method initialize(type:, after: nil, limit: nil, request_options: {})
30
30
  # Some parameter documentations has been truncated, see
31
- # {Spotted::Models::Me::FollowingListParams} for more details.
31
+ # {Spotted::Models::Me::FollowingBulkRetrieveParams} for more details.
32
32
  #
33
- # @param type [Symbol, Spotted::Models::Me::FollowingListParams::Type] The ID type: currently only `artist` is supported.
33
+ # @param type [Symbol, Spotted::Models::Me::FollowingBulkRetrieveParams::Type] The ID type: currently only `artist` is supported.
34
34
  #
35
35
  # @param after [String] The last artist ID retrieved from the previous request.
36
36
  #
@@ -3,23 +3,23 @@
3
3
  module Spotted
4
4
  module Models
5
5
  module Me
6
- # @see Spotted::Resources::Me::Following#list
7
- class FollowingListResponse < Spotted::Internal::Type::BaseModel
6
+ # @see Spotted::Resources::Me::Following#bulk_retrieve
7
+ class FollowingBulkRetrieveResponse < Spotted::Internal::Type::BaseModel
8
8
  # @!attribute artists
9
9
  #
10
- # @return [Spotted::Models::Me::FollowingListResponse::Artists]
11
- required :artists, -> { Spotted::Models::Me::FollowingListResponse::Artists }
10
+ # @return [Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists]
11
+ required :artists, -> { Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists }
12
12
 
13
13
  # @!method initialize(artists:)
14
- # @param artists [Spotted::Models::Me::FollowingListResponse::Artists]
14
+ # @param artists [Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists]
15
15
 
16
- # @see Spotted::Models::Me::FollowingListResponse#artists
16
+ # @see Spotted::Models::Me::FollowingBulkRetrieveResponse#artists
17
17
  class Artists < Spotted::Internal::Type::BaseModel
18
18
  # @!attribute cursors
19
19
  # The cursors used to find the next set of items.
20
20
  #
21
- # @return [Spotted::Models::Me::FollowingListResponse::Artists::Cursors, nil]
22
- optional :cursors, -> { Spotted::Models::Me::FollowingListResponse::Artists::Cursors }
21
+ # @return [Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists::Cursors, nil]
22
+ optional :cursors, -> { Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists::Cursors }
23
23
 
24
24
  # @!attribute href
25
25
  # A link to the Web API endpoint returning the full result of the request.
@@ -52,9 +52,9 @@ module Spotted
52
52
 
53
53
  # @!method initialize(cursors: nil, href: nil, items: nil, limit: nil, next_: nil, total: nil)
54
54
  # Some parameter documentations has been truncated, see
55
- # {Spotted::Models::Me::FollowingListResponse::Artists} for more details.
55
+ # {Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists} for more details.
56
56
  #
57
- # @param cursors [Spotted::Models::Me::FollowingListResponse::Artists::Cursors] The cursors used to find the next set of items.
57
+ # @param cursors [Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists::Cursors] The cursors used to find the next set of items.
58
58
  #
59
59
  # @param href [String] A link to the Web API endpoint returning the full result of the request.
60
60
  #
@@ -66,7 +66,7 @@ module Spotted
66
66
  #
67
67
  # @param total [Integer] The total number of items available to return.
68
68
 
69
- # @see Spotted::Models::Me::FollowingListResponse::Artists#cursors
69
+ # @see Spotted::Models::Me::FollowingBulkRetrieveResponse::Artists#cursors
70
70
  class Cursors < Spotted::Internal::Type::BaseModel
71
71
  # @!attribute after
72
72
  # The cursor to use as key to find the next page of items.
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Spotted
4
4
  module Models
5
- # @see Spotted::Resources::Search#search
6
- class SearchSearchParams < Spotted::Internal::Type::BaseModel
5
+ # @see Spotted::Resources::Search#query
6
+ class SearchQueryParams < Spotted::Internal::Type::BaseModel
7
7
  extend Spotted::Internal::Type::RequestParameters::Converter
8
8
  include Spotted::Internal::Type::RequestParameters
9
9
 
@@ -31,8 +31,8 @@ module Spotted
31
31
  # hits from all the specified item types. For example: `q=abacab&type=album,track`
32
32
  # returns both albums and tracks matching "abacab".
33
33
  #
34
- # @return [Array<Symbol, Spotted::Models::SearchSearchParams::Type>]
35
- required :type, -> { Spotted::Internal::Type::ArrayOf[enum: Spotted::SearchSearchParams::Type] }
34
+ # @return [Array<Symbol, Spotted::Models::SearchQueryParams::Type>]
35
+ required :type, -> { Spotted::Internal::Type::ArrayOf[enum: Spotted::SearchQueryParams::Type] }
36
36
 
37
37
  # @!attribute include_external
38
38
  # If `include_external=audio` is specified it signals that the client can play
@@ -40,8 +40,8 @@ module Spotted
40
40
  # response. By default externally hosted audio content is marked as unplayable in
41
41
  # the response.
42
42
  #
43
- # @return [Symbol, Spotted::Models::SearchSearchParams::IncludeExternal, nil]
44
- optional :include_external, enum: -> { Spotted::SearchSearchParams::IncludeExternal }
43
+ # @return [Symbol, Spotted::Models::SearchQueryParams::IncludeExternal, nil]
44
+ optional :include_external, enum: -> { Spotted::SearchQueryParams::IncludeExternal }
45
45
 
46
46
  # @!attribute limit
47
47
  # The maximum number of results to return in each item type.
@@ -72,13 +72,13 @@ module Spotted
72
72
 
73
73
  # @!method initialize(q:, type:, include_external: nil, limit: nil, market: nil, offset: nil, request_options: {})
74
74
  # Some parameter documentations has been truncated, see
75
- # {Spotted::Models::SearchSearchParams} for more details.
75
+ # {Spotted::Models::SearchQueryParams} for more details.
76
76
  #
77
77
  # @param q [String] Your search query.
78
78
  #
79
- # @param type [Array<Symbol, Spotted::Models::SearchSearchParams::Type>] A comma-separated list of item types to search across. Search results include hi
79
+ # @param type [Array<Symbol, Spotted::Models::SearchQueryParams::Type>] A comma-separated list of item types to search across. Search results include hi
80
80
  #
81
- # @param include_external [Symbol, Spotted::Models::SearchSearchParams::IncludeExternal] If `include_external=audio` is specified it signals that the client can play ext
81
+ # @param include_external [Symbol, Spotted::Models::SearchQueryParams::IncludeExternal] If `include_external=audio` is specified it signals that the client can play ext
82
82
  #
83
83
  # @param limit [Integer] The maximum number of results to return in each item type.
84
84
  #