spotted 0.1.0 → 0.2.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 (45) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/spotted/models/audiobook_base.rb +182 -0
  5. data/lib/spotted/models/audiobook_list_response.rb +2 -174
  6. data/lib/spotted/models/audiobook_retrieve_response.rb +2 -174
  7. data/lib/spotted/models/chapter_list_response.rb +3 -183
  8. data/lib/spotted/models/chapter_retrieve_response.rb +3 -183
  9. data/lib/spotted/models/episode_object.rb +3 -166
  10. data/lib/spotted/models/me/audiobook_list_response.rb +2 -174
  11. data/lib/spotted/models/me/show_list_response.rb +3 -166
  12. data/lib/spotted/models/search_retrieve_response.rb +6 -345
  13. data/lib/spotted/models/show_base.rb +165 -0
  14. data/lib/spotted/models/show_list_response.rb +3 -163
  15. data/lib/spotted/models/show_retrieve_response.rb +2 -157
  16. data/lib/spotted/models.rb +4 -0
  17. data/lib/spotted/version.rb +1 -1
  18. data/lib/spotted.rb +2 -0
  19. data/rbi/spotted/models/audiobook_base.rbi +219 -0
  20. data/rbi/spotted/models/audiobook_list_response.rbi +4 -212
  21. data/rbi/spotted/models/audiobook_retrieve_response.rbi +4 -209
  22. data/rbi/spotted/models/chapter_list_response.rbi +4 -249
  23. data/rbi/spotted/models/chapter_retrieve_response.rbi +4 -245
  24. data/rbi/spotted/models/episode_object.rbi +4 -199
  25. data/rbi/spotted/models/me/audiobook_list_response.rbi +4 -212
  26. data/rbi/spotted/models/me/show_list_response.rbi +6 -227
  27. data/rbi/spotted/models/search_retrieve_response.rbi +6 -473
  28. data/rbi/spotted/models/show_base.rbi +194 -0
  29. data/rbi/spotted/models/show_list_response.rbi +5 -216
  30. data/rbi/spotted/models/show_retrieve_response.rbi +4 -182
  31. data/rbi/spotted/models.rbi +4 -0
  32. data/sig/spotted/models/audiobook_base.rbs +122 -0
  33. data/sig/spotted/models/audiobook_list_response.rbs +8 -111
  34. data/sig/spotted/models/audiobook_retrieve_response.rbs +8 -113
  35. data/sig/spotted/models/chapter_list_response.rbs +4 -123
  36. data/sig/spotted/models/chapter_retrieve_response.rbs +4 -123
  37. data/sig/spotted/models/episode_object.rbs +4 -111
  38. data/sig/spotted/models/me/audiobook_list_response.rbs +8 -111
  39. data/sig/spotted/models/me/show_list_response.rbs +5 -121
  40. data/sig/spotted/models/search_retrieve_response.rbs +8 -234
  41. data/sig/spotted/models/show_base.rbs +110 -0
  42. data/sig/spotted/models/show_list_response.rbs +4 -116
  43. data/sig/spotted/models/show_retrieve_response.rbs +8 -101
  44. data/sig/spotted/models.rbs +4 -0
  45. metadata +7 -1
@@ -30,181 +30,21 @@ module Spotted
30
30
  # @param audiobook [Spotted::Models::Me::AudiobookListResponse::Audiobook] Information about the audiobook.
31
31
 
32
32
  # @see Spotted::Models::Me::AudiobookListResponse#audiobook
33
- class Audiobook < Spotted::Internal::Type::BaseModel
34
- # @!attribute id
35
- # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
36
- # audiobook.
37
- #
38
- # @return [String]
39
- required :id, String
40
-
41
- # @!attribute authors
42
- # The author(s) for the audiobook.
43
- #
44
- # @return [Array<Spotted::Models::AuthorObject>]
45
- required :authors, -> { Spotted::Internal::Type::ArrayOf[Spotted::AuthorObject] }
46
-
47
- # @!attribute available_markets
48
- # A list of the countries in which the audiobook can be played, identified by
49
- # their [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
50
- # code.
51
- #
52
- # @return [Array<String>]
53
- required :available_markets, Spotted::Internal::Type::ArrayOf[String]
54
-
33
+ class Audiobook < Spotted::Models::AudiobookBase
55
34
  # @!attribute chapters
56
35
  # The chapters of the audiobook.
57
36
  #
58
37
  # @return [Spotted::Models::Me::AudiobookListResponse::Audiobook::Chapters]
59
38
  required :chapters, -> { Spotted::Models::Me::AudiobookListResponse::Audiobook::Chapters }
60
39
 
61
- # @!attribute copyrights
62
- # The copyright statements of the audiobook.
63
- #
64
- # @return [Array<Spotted::Models::CopyrightObject>]
65
- required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
66
-
67
- # @!attribute description
68
- # A description of the audiobook. HTML tags are stripped away from this field, use
69
- # `html_description` field in case HTML tags are needed.
70
- #
71
- # @return [String]
72
- required :description, String
73
-
74
- # @!attribute explicit
75
- # Whether or not the audiobook has explicit content (true = yes it does; false =
76
- # no it does not OR unknown).
77
- #
78
- # @return [Boolean]
79
- required :explicit, Spotted::Internal::Type::Boolean
80
-
81
- # @!attribute external_urls
82
- # External URLs for this audiobook.
83
- #
84
- # @return [Spotted::Models::ExternalURLObject]
85
- required :external_urls, -> { Spotted::ExternalURLObject }
86
-
87
- # @!attribute href
88
- # A link to the Web API endpoint providing full details of the audiobook.
89
- #
90
- # @return [String]
91
- required :href, String
92
-
93
- # @!attribute html_description
94
- # A description of the audiobook. This field may contain HTML tags.
95
- #
96
- # @return [String]
97
- required :html_description, String
98
-
99
- # @!attribute images
100
- # The cover art for the audiobook in various sizes, widest first.
101
- #
102
- # @return [Array<Spotted::Models::ImageObject>]
103
- required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
104
-
105
- # @!attribute languages
106
- # A list of the languages used in the audiobook, identified by their
107
- # [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
108
- #
109
- # @return [Array<String>]
110
- required :languages, Spotted::Internal::Type::ArrayOf[String]
111
-
112
- # @!attribute media_type
113
- # The media type of the audiobook.
114
- #
115
- # @return [String]
116
- required :media_type, String
117
-
118
- # @!attribute name
119
- # The name of the audiobook.
120
- #
121
- # @return [String]
122
- required :name, String
123
-
124
- # @!attribute narrators
125
- # The narrator(s) for the audiobook.
126
- #
127
- # @return [Array<Spotted::Models::NarratorObject>]
128
- required :narrators, -> { Spotted::Internal::Type::ArrayOf[Spotted::NarratorObject] }
129
-
130
- # @!attribute publisher
131
- # The publisher of the audiobook.
132
- #
133
- # @return [String]
134
- required :publisher, String
135
-
136
- # @!attribute total_chapters
137
- # The number of chapters in this audiobook.
138
- #
139
- # @return [Integer]
140
- required :total_chapters, Integer
141
-
142
- # @!attribute type
143
- # The object type.
144
- #
145
- # @return [Symbol, Spotted::Models::Me::AudiobookListResponse::Audiobook::Type]
146
- required :type, enum: -> { Spotted::Models::Me::AudiobookListResponse::Audiobook::Type }
147
-
148
- # @!attribute uri
149
- # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
150
- # audiobook.
151
- #
152
- # @return [String]
153
- required :uri, String
154
-
155
- # @!attribute edition
156
- # The edition of the audiobook.
157
- #
158
- # @return [String, nil]
159
- optional :edition, String
160
-
161
- # @!method initialize(id:, authors:, available_markets:, chapters:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, languages:, media_type:, name:, narrators:, publisher:, total_chapters:, type:, uri:, edition: nil)
40
+ # @!method initialize(chapters:)
162
41
  # Some parameter documentations has been truncated, see
163
42
  # {Spotted::Models::Me::AudiobookListResponse::Audiobook} for more details.
164
43
  #
165
44
  # Information about the audiobook.
166
45
  #
167
- # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the audio
168
- #
169
- # @param authors [Array<Spotted::Models::AuthorObject>] The author(s) for the audiobook.
170
- #
171
- # @param available_markets [Array<String>] A list of the countries in which the audiobook can be played, identified by thei
172
- #
173
46
  # @param chapters [Spotted::Models::Me::AudiobookListResponse::Audiobook::Chapters] The chapters of the audiobook.
174
- #
175
- # @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the audiobook.
176
- #
177
- # @param description [String] A description of the audiobook. HTML tags are stripped away from this field, use
178
- #
179
- # @param explicit [Boolean] Whether or not the audiobook has explicit content (true = yes it does; false = n
180
- #
181
- # @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this audiobook.
182
- #
183
- # @param href [String] A link to the Web API endpoint providing full details of the audiobook.
184
- #
185
- # @param html_description [String] A description of the audiobook. This field may contain HTML tags.
186
- #
187
- # @param images [Array<Spotted::Models::ImageObject>] The cover art for the audiobook in various sizes, widest first.
188
- #
189
- # @param languages [Array<String>] A list of the languages used in the audiobook, identified by their [ISO 639](htt
190
- #
191
- # @param media_type [String] The media type of the audiobook.
192
- #
193
- # @param name [String] The name of the audiobook.
194
- #
195
- # @param narrators [Array<Spotted::Models::NarratorObject>] The narrator(s) for the audiobook.
196
- #
197
- # @param publisher [String] The publisher of the audiobook.
198
- #
199
- # @param total_chapters [Integer] The number of chapters in this audiobook.
200
- #
201
- # @param type [Symbol, Spotted::Models::Me::AudiobookListResponse::Audiobook::Type] The object type.
202
- #
203
- # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the audi
204
- #
205
- # @param edition [String] The edition of the audiobook.
206
47
 
207
- # @see Spotted::Models::Me::AudiobookListResponse::Audiobook#chapters
208
48
  class Chapters < Spotted::Internal::Type::BaseModel
209
49
  # @!attribute href
210
50
  # A link to the Web API endpoint returning the full result of the request
@@ -268,18 +108,6 @@ module Spotted
268
108
  #
269
109
  # @param total [Integer] The total number of items available to return.
270
110
  end
271
-
272
- # The object type.
273
- #
274
- # @see Spotted::Models::Me::AudiobookListResponse::Audiobook#type
275
- module Type
276
- extend Spotted::Internal::Type::Enum
277
-
278
- AUDIOBOOK = :audiobook
279
-
280
- # @!method self.values
281
- # @return [Array<Symbol>]
282
- end
283
111
  end
284
112
  end
285
113
  end
@@ -18,8 +18,8 @@ module Spotted
18
18
  # @!attribute show
19
19
  # Information about the show.
20
20
  #
21
- # @return [Spotted::Models::Me::ShowListResponse::Show, nil]
22
- optional :show, -> { Spotted::Models::Me::ShowListResponse::Show }
21
+ # @return [Spotted::Models::ShowBase, nil]
22
+ optional :show, -> { Spotted::ShowBase }
23
23
 
24
24
  # @!method initialize(added_at: nil, show: nil)
25
25
  # Some parameter documentations has been truncated, see
@@ -27,170 +27,7 @@ module Spotted
27
27
  #
28
28
  # @param added_at [Time] The date and time the show was saved.
29
29
  #
30
- # @param show [Spotted::Models::Me::ShowListResponse::Show] Information about the show.
31
-
32
- # @see Spotted::Models::Me::ShowListResponse#show
33
- class Show < Spotted::Internal::Type::BaseModel
34
- # @!attribute id
35
- # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
36
- #
37
- # @return [String]
38
- required :id, String
39
-
40
- # @!attribute available_markets
41
- # A list of the countries in which the show can be played, identified by their
42
- # [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
43
- #
44
- # @return [Array<String>]
45
- required :available_markets, Spotted::Internal::Type::ArrayOf[String]
46
-
47
- # @!attribute copyrights
48
- # The copyright statements of the show.
49
- #
50
- # @return [Array<Spotted::Models::CopyrightObject>]
51
- required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
52
-
53
- # @!attribute description
54
- # A description of the show. HTML tags are stripped away from this field, use
55
- # `html_description` field in case HTML tags are needed.
56
- #
57
- # @return [String]
58
- required :description, String
59
-
60
- # @!attribute explicit
61
- # Whether or not the show has explicit content (true = yes it does; false = no it
62
- # does not OR unknown).
63
- #
64
- # @return [Boolean]
65
- required :explicit, Spotted::Internal::Type::Boolean
66
-
67
- # @!attribute external_urls
68
- # External URLs for this show.
69
- #
70
- # @return [Spotted::Models::ExternalURLObject]
71
- required :external_urls, -> { Spotted::ExternalURLObject }
72
-
73
- # @!attribute href
74
- # A link to the Web API endpoint providing full details of the show.
75
- #
76
- # @return [String]
77
- required :href, String
78
-
79
- # @!attribute html_description
80
- # A description of the show. This field may contain HTML tags.
81
- #
82
- # @return [String]
83
- required :html_description, String
84
-
85
- # @!attribute images
86
- # The cover art for the show in various sizes, widest first.
87
- #
88
- # @return [Array<Spotted::Models::ImageObject>]
89
- required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
90
-
91
- # @!attribute is_externally_hosted
92
- # True if all of the shows episodes are hosted outside of Spotify's CDN. This
93
- # field might be `null` in some cases.
94
- #
95
- # @return [Boolean]
96
- required :is_externally_hosted, Spotted::Internal::Type::Boolean
97
-
98
- # @!attribute languages
99
- # A list of the languages used in the show, identified by their
100
- # [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
101
- #
102
- # @return [Array<String>]
103
- required :languages, Spotted::Internal::Type::ArrayOf[String]
104
-
105
- # @!attribute media_type
106
- # The media type of the show.
107
- #
108
- # @return [String]
109
- required :media_type, String
110
-
111
- # @!attribute name
112
- # The name of the episode.
113
- #
114
- # @return [String]
115
- required :name, String
116
-
117
- # @!attribute publisher
118
- # The publisher of the show.
119
- #
120
- # @return [String]
121
- required :publisher, String
122
-
123
- # @!attribute total_episodes
124
- # The total number of episodes in the show.
125
- #
126
- # @return [Integer]
127
- required :total_episodes, Integer
128
-
129
- # @!attribute type
130
- # The object type.
131
- #
132
- # @return [Symbol, Spotted::Models::Me::ShowListResponse::Show::Type]
133
- required :type, enum: -> { Spotted::Models::Me::ShowListResponse::Show::Type }
134
-
135
- # @!attribute uri
136
- # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
137
- # show.
138
- #
139
- # @return [String]
140
- required :uri, String
141
-
142
- # @!method initialize(id:, available_markets:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, languages:, media_type:, name:, publisher:, total_episodes:, type:, uri:)
143
- # Some parameter documentations has been truncated, see
144
- # {Spotted::Models::Me::ShowListResponse::Show} for more details.
145
- #
146
- # Information about the show.
147
- #
148
- # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
149
- #
150
- # @param available_markets [Array<String>] A list of the countries in which the show can be played, identified by their [IS
151
- #
152
- # @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the show.
153
- #
154
- # @param description [String] A description of the show. HTML tags are stripped away from this field, use `htm
155
- #
156
- # @param explicit [Boolean] Whether or not the show has explicit content (true = yes it does; false = no it
157
- #
158
- # @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this show.
159
- #
160
- # @param href [String] A link to the Web API endpoint providing full details of the show.
161
- #
162
- # @param html_description [String] A description of the show. This field may contain HTML tags.
163
- #
164
- # @param images [Array<Spotted::Models::ImageObject>] The cover art for the show in various sizes, widest first.
165
- #
166
- # @param is_externally_hosted [Boolean] True if all of the shows episodes are hosted outside of Spotify's CDN. This fiel
167
- #
168
- # @param languages [Array<String>] A list of the languages used in the show, identified by their [ISO 639](https://
169
- #
170
- # @param media_type [String] The media type of the show.
171
- #
172
- # @param name [String] The name of the episode.
173
- #
174
- # @param publisher [String] The publisher of the show.
175
- #
176
- # @param total_episodes [Integer] The total number of episodes in the show.
177
- #
178
- # @param type [Symbol, Spotted::Models::Me::ShowListResponse::Show::Type] The object type.
179
- #
180
- # @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show
181
-
182
- # The object type.
183
- #
184
- # @see Spotted::Models::Me::ShowListResponse::Show#type
185
- module Type
186
- extend Spotted::Internal::Type::Enum
187
-
188
- SHOW = :show
189
-
190
- # @!method self.values
191
- # @return [Array<Symbol>]
192
- end
193
- end
30
+ # @param show [Spotted::Models::ShowBase] Information about the show.
194
31
  end
195
32
  end
196
33
  end