spotted 0.1.0 → 0.2.0

data/lib/spotted/models/chapter_list_response.rb

@@ -32,8 +32,8 @@ module Spotted
         # @!attribute audiobook
         #   The audiobook for which the chapter belongs.
         #
-        #   @return [Spotted::Models::ChapterListResponse::Chapter::Audiobook]
-        required :audiobook, -> { Spotted::Models::ChapterListResponse::Chapter::Audiobook }
+        #   @return [Spotted::Models::AudiobookBase]
+        required :audiobook, -> { Spotted::AudiobookBase }
 
         # @!attribute chapter_number
         #   The number of the chapter
@@ -159,7 +159,7 @@ module Spotted
         #
         #   @param audio_preview_url [String, nil] A URL to a 30 second preview (MP3 format) of the chapter. `null` if not availabl
         #
-        #   @param audiobook [Spotted::Models::ChapterListResponse::Chapter::Audiobook] The audiobook for which the chapter belongs.
+        #   @param audiobook [Spotted::Models::AudiobookBase] The audiobook for which the chapter belongs.
         #
         #   @param chapter_number [Integer] The number of the chapter
         #
@@ -197,186 +197,6 @@ module Spotted
         #
         #   @param resume_point [Spotted::Models::ResumePointObject] The user's most recent position in the chapter. Set if the supplied access token
 
-        # @see Spotted::Models::ChapterListResponse::Chapter#audiobook
-        class Audiobook < Spotted::Internal::Type::BaseModel
-          # @!attribute id
-          #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
-          #   audiobook.
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute authors
-          #   The author(s) for the audiobook.
-          #
-          #   @return [Array<Spotted::Models::AuthorObject>]
-          required :authors, -> { Spotted::Internal::Type::ArrayOf[Spotted::AuthorObject] }
-
-          # @!attribute available_markets
-          #   A list of the countries in which the audiobook can be played, identified by
-          #   their [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
-          #   code.
-          #
-          #   @return [Array<String>]
-          required :available_markets, Spotted::Internal::Type::ArrayOf[String]
-
-          # @!attribute copyrights
-          #   The copyright statements of the audiobook.
-          #
-          #   @return [Array<Spotted::Models::CopyrightObject>]
-          required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
-
-          # @!attribute description
-          #   A description of the audiobook. HTML tags are stripped away from this field, use
-          #   `html_description` field in case HTML tags are needed.
-          #
-          #   @return [String]
-          required :description, String
-
-          # @!attribute explicit
-          #   Whether or not the audiobook has explicit content (true = yes it does; false =
-          #   no it does not OR unknown).
-          #
-          #   @return [Boolean]
-          required :explicit, Spotted::Internal::Type::Boolean
-
-          # @!attribute external_urls
-          #   External URLs for this audiobook.
-          #
-          #   @return [Spotted::Models::ExternalURLObject]
-          required :external_urls, -> { Spotted::ExternalURLObject }
-
-          # @!attribute href
-          #   A link to the Web API endpoint providing full details of the audiobook.
-          #
-          #   @return [String]
-          required :href, String
-
-          # @!attribute html_description
-          #   A description of the audiobook. This field may contain HTML tags.
-          #
-          #   @return [String]
-          required :html_description, String
-
-          # @!attribute images
-          #   The cover art for the audiobook in various sizes, widest first.
-          #
-          #   @return [Array<Spotted::Models::ImageObject>]
-          required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
-
-          # @!attribute languages
-          #   A list of the languages used in the audiobook, identified by their
-          #   [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
-          #
-          #   @return [Array<String>]
-          required :languages, Spotted::Internal::Type::ArrayOf[String]
-
-          # @!attribute media_type
-          #   The media type of the audiobook.
-          #
-          #   @return [String]
-          required :media_type, String
-
-          # @!attribute name
-          #   The name of the audiobook.
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute narrators
-          #   The narrator(s) for the audiobook.
-          #
-          #   @return [Array<Spotted::Models::NarratorObject>]
-          required :narrators, -> { Spotted::Internal::Type::ArrayOf[Spotted::NarratorObject] }
-
-          # @!attribute publisher
-          #   The publisher of the audiobook.
-          #
-          #   @return [String]
-          required :publisher, String
-
-          # @!attribute total_chapters
-          #   The number of chapters in this audiobook.
-          #
-          #   @return [Integer]
-          required :total_chapters, Integer
-
-          # @!attribute type
-          #   The object type.
-          #
-          #   @return [Symbol, Spotted::Models::ChapterListResponse::Chapter::Audiobook::Type]
-          required :type, enum: -> { Spotted::Models::ChapterListResponse::Chapter::Audiobook::Type }
-
-          # @!attribute uri
-          #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
-          #   audiobook.
-          #
-          #   @return [String]
-          required :uri, String
-
-          # @!attribute edition
-          #   The edition of the audiobook.
-          #
-          #   @return [String, nil]
-          optional :edition, String
-
-          # @!method initialize(id:, authors:, available_markets:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, languages:, media_type:, name:, narrators:, publisher:, total_chapters:, type:, uri:, edition: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Spotted::Models::ChapterListResponse::Chapter::Audiobook} for more details.
-          #
-          #   The audiobook for which the chapter belongs.
-          #
-          #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the audio
-          #
-          #   @param authors [Array<Spotted::Models::AuthorObject>] The author(s) for the audiobook.
-          #
-          #   @param available_markets [Array<String>] A list of the countries in which the audiobook can be played, identified by thei
-          #
-          #   @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the audiobook.
-          #
-          #   @param description [String] A description of the audiobook. HTML tags are stripped away from this field, use
-          #
-          #   @param explicit [Boolean] Whether or not the audiobook has explicit content (true = yes it does; false = n
-          #
-          #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this audiobook.
-          #
-          #   @param href [String] A link to the Web API endpoint providing full details of the audiobook.
-          #
-          #   @param html_description [String] A description of the audiobook. This field may contain HTML tags.
-          #
-          #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the audiobook in various sizes, widest first.
-          #
-          #   @param languages [Array<String>] A list of the languages used in the audiobook, identified by their [ISO 639](htt
-          #
-          #   @param media_type [String] The media type of the audiobook.
-          #
-          #   @param name [String] The name of the audiobook.
-          #
-          #   @param narrators [Array<Spotted::Models::NarratorObject>] The narrator(s) for the audiobook.
-          #
-          #   @param publisher [String] The publisher of the audiobook.
-          #
-          #   @param total_chapters [Integer] The number of chapters in this audiobook.
-          #
-          #   @param type [Symbol, Spotted::Models::ChapterListResponse::Chapter::Audiobook::Type] The object type.
-          #
-          #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the audi
-          #
-          #   @param edition [String] The edition of the audiobook.
-
-          # The object type.
-          #
-          # @see Spotted::Models::ChapterListResponse::Chapter::Audiobook#type
-          module Type
-            extend Spotted::Internal::Type::Enum
-
-            AUDIOBOOK = :audiobook
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-
         # The precision with which `release_date` value is known.
         #
         # @see Spotted::Models::ChapterListResponse::Chapter#release_date_precision

data/lib/spotted/models/chapter_retrieve_response.rb

@@ -23,8 +23,8 @@ module Spotted
       # @!attribute audiobook
       #   The audiobook for which the chapter belongs.
       #
-      #   @return [Spotted::Models::ChapterRetrieveResponse::Audiobook]
-      required :audiobook, -> { Spotted::Models::ChapterRetrieveResponse::Audiobook }
+      #   @return [Spotted::Models::AudiobookBase]
+      required :audiobook, -> { Spotted::AudiobookBase }
 
       # @!attribute chapter_number
       #   The number of the chapter
@@ -150,7 +150,7 @@ module Spotted
       #
       #   @param audio_preview_url [String, nil] A URL to a 30 second preview (MP3 format) of the chapter. `null` if not availabl
       #
-      #   @param audiobook [Spotted::Models::ChapterRetrieveResponse::Audiobook] The audiobook for which the chapter belongs.
+      #   @param audiobook [Spotted::Models::AudiobookBase] The audiobook for which the chapter belongs.
       #
       #   @param chapter_number [Integer] The number of the chapter
       #
@@ -188,186 +188,6 @@ module Spotted
       #
       #   @param resume_point [Spotted::Models::ResumePointObject] The user's most recent position in the chapter. Set if the supplied access token
 
-      # @see Spotted::Models::ChapterRetrieveResponse#audiobook
-      class Audiobook < Spotted::Internal::Type::BaseModel
-        # @!attribute id
-        #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
-        #   audiobook.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute authors
-        #   The author(s) for the audiobook.
-        #
-        #   @return [Array<Spotted::Models::AuthorObject>]
-        required :authors, -> { Spotted::Internal::Type::ArrayOf[Spotted::AuthorObject] }
-
-        # @!attribute available_markets
-        #   A list of the countries in which the audiobook can be played, identified by
-        #   their [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
-        #   code.
-        #
-        #   @return [Array<String>]
-        required :available_markets, Spotted::Internal::Type::ArrayOf[String]
-
-        # @!attribute copyrights
-        #   The copyright statements of the audiobook.
-        #
-        #   @return [Array<Spotted::Models::CopyrightObject>]
-        required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
-
-        # @!attribute description
-        #   A description of the audiobook. HTML tags are stripped away from this field, use
-        #   `html_description` field in case HTML tags are needed.
-        #
-        #   @return [String]
-        required :description, String
-
-        # @!attribute explicit
-        #   Whether or not the audiobook has explicit content (true = yes it does; false =
-        #   no it does not OR unknown).
-        #
-        #   @return [Boolean]
-        required :explicit, Spotted::Internal::Type::Boolean
-
-        # @!attribute external_urls
-        #   External URLs for this audiobook.
-        #
-        #   @return [Spotted::Models::ExternalURLObject]
-        required :external_urls, -> { Spotted::ExternalURLObject }
-
-        # @!attribute href
-        #   A link to the Web API endpoint providing full details of the audiobook.
-        #
-        #   @return [String]
-        required :href, String
-
-        # @!attribute html_description
-        #   A description of the audiobook. This field may contain HTML tags.
-        #
-        #   @return [String]
-        required :html_description, String
-
-        # @!attribute images
-        #   The cover art for the audiobook in various sizes, widest first.
-        #
-        #   @return [Array<Spotted::Models::ImageObject>]
-        required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
-
-        # @!attribute languages
-        #   A list of the languages used in the audiobook, identified by their
-        #   [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
-        #
-        #   @return [Array<String>]
-        required :languages, Spotted::Internal::Type::ArrayOf[String]
-
-        # @!attribute media_type
-        #   The media type of the audiobook.
-        #
-        #   @return [String]
-        required :media_type, String
-
-        # @!attribute name
-        #   The name of the audiobook.
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute narrators
-        #   The narrator(s) for the audiobook.
-        #
-        #   @return [Array<Spotted::Models::NarratorObject>]
-        required :narrators, -> { Spotted::Internal::Type::ArrayOf[Spotted::NarratorObject] }
-
-        # @!attribute publisher
-        #   The publisher of the audiobook.
-        #
-        #   @return [String]
-        required :publisher, String
-
-        # @!attribute total_chapters
-        #   The number of chapters in this audiobook.
-        #
-        #   @return [Integer]
-        required :total_chapters, Integer
-
-        # @!attribute type
-        #   The object type.
-        #
-        #   @return [Symbol, Spotted::Models::ChapterRetrieveResponse::Audiobook::Type]
-        required :type, enum: -> { Spotted::Models::ChapterRetrieveResponse::Audiobook::Type }
-
-        # @!attribute uri
-        #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
-        #   audiobook.
-        #
-        #   @return [String]
-        required :uri, String
-
-        # @!attribute edition
-        #   The edition of the audiobook.
-        #
-        #   @return [String, nil]
-        optional :edition, String
-
-        # @!method initialize(id:, authors:, available_markets:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, languages:, media_type:, name:, narrators:, publisher:, total_chapters:, type:, uri:, edition: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Spotted::Models::ChapterRetrieveResponse::Audiobook} for more details.
-        #
-        #   The audiobook for which the chapter belongs.
-        #
-        #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the audio
-        #
-        #   @param authors [Array<Spotted::Models::AuthorObject>] The author(s) for the audiobook.
-        #
-        #   @param available_markets [Array<String>] A list of the countries in which the audiobook can be played, identified by thei
-        #
-        #   @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the audiobook.
-        #
-        #   @param description [String] A description of the audiobook. HTML tags are stripped away from this field, use
-        #
-        #   @param explicit [Boolean] Whether or not the audiobook has explicit content (true = yes it does; false = n
-        #
-        #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this audiobook.
-        #
-        #   @param href [String] A link to the Web API endpoint providing full details of the audiobook.
-        #
-        #   @param html_description [String] A description of the audiobook. This field may contain HTML tags.
-        #
-        #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the audiobook in various sizes, widest first.
-        #
-        #   @param languages [Array<String>] A list of the languages used in the audiobook, identified by their [ISO 639](htt
-        #
-        #   @param media_type [String] The media type of the audiobook.
-        #
-        #   @param name [String] The name of the audiobook.
-        #
-        #   @param narrators [Array<Spotted::Models::NarratorObject>] The narrator(s) for the audiobook.
-        #
-        #   @param publisher [String] The publisher of the audiobook.
-        #
-        #   @param total_chapters [Integer] The number of chapters in this audiobook.
-        #
-        #   @param type [Symbol, Spotted::Models::ChapterRetrieveResponse::Audiobook::Type] The object type.
-        #
-        #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the audi
-        #
-        #   @param edition [String] The edition of the audiobook.
-
-        # The object type.
-        #
-        # @see Spotted::Models::ChapterRetrieveResponse::Audiobook#type
-        module Type
-          extend Spotted::Internal::Type::Enum
-
-          AUDIOBOOK = :audiobook
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       # The precision with which `release_date` value is known.
       #
       # @see Spotted::Models::ChapterRetrieveResponse#release_date_precision

data/lib/spotted/models/episode_object.rb

@@ -104,8 +104,8 @@ module Spotted
       # @!attribute show
       #   The show on which the episode belongs.
       #
-      #   @return [Spotted::Models::EpisodeObject::Show]
-      required :show, -> { Spotted::EpisodeObject::Show }
+      #   @return [Spotted::Models::ShowBase]
+      required :show, -> { Spotted::ShowBase }
 
       # @!attribute type
       #   The object type.
@@ -177,7 +177,7 @@ module Spotted
       #
       #   @param release_date_precision [Symbol, Spotted::Models::EpisodeObject::ReleaseDatePrecision] The precision with which `release_date` value is known.
       #
-      #   @param show [Spotted::Models::EpisodeObject::Show] The show on which the episode belongs.
+      #   @param show [Spotted::Models::ShowBase] The show on which the episode belongs.
       #
       #   @param type [Symbol, Spotted::Models::EpisodeObject::Type] The object type.
       #
@@ -203,169 +203,6 @@ module Spotted
         #   @return [Array<Symbol>]
       end
 
-      # @see Spotted::Models::EpisodeObject#show
-      class Show < Spotted::Internal::Type::BaseModel
-        # @!attribute id
-        #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute available_markets
-        #   A list of the countries in which the show can be played, identified by their
-        #   [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
-        #
-        #   @return [Array<String>]
-        required :available_markets, Spotted::Internal::Type::ArrayOf[String]
-
-        # @!attribute copyrights
-        #   The copyright statements of the show.
-        #
-        #   @return [Array<Spotted::Models::CopyrightObject>]
-        required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
-
-        # @!attribute description
-        #   A description of the show. HTML tags are stripped away from this field, use
-        #   `html_description` field in case HTML tags are needed.
-        #
-        #   @return [String]
-        required :description, String
-
-        # @!attribute explicit
-        #   Whether or not the show has explicit content (true = yes it does; false = no it
-        #   does not OR unknown).
-        #
-        #   @return [Boolean]
-        required :explicit, Spotted::Internal::Type::Boolean
-
-        # @!attribute external_urls
-        #   External URLs for this show.
-        #
-        #   @return [Spotted::Models::ExternalURLObject]
-        required :external_urls, -> { Spotted::ExternalURLObject }
-
-        # @!attribute href
-        #   A link to the Web API endpoint providing full details of the show.
-        #
-        #   @return [String]
-        required :href, String
-
-        # @!attribute html_description
-        #   A description of the show. This field may contain HTML tags.
-        #
-        #   @return [String]
-        required :html_description, String
-
-        # @!attribute images
-        #   The cover art for the show in various sizes, widest first.
-        #
-        #   @return [Array<Spotted::Models::ImageObject>]
-        required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
-
-        # @!attribute is_externally_hosted
-        #   True if all of the shows episodes are hosted outside of Spotify's CDN. This
-        #   field might be `null` in some cases.
-        #
-        #   @return [Boolean]
-        required :is_externally_hosted, Spotted::Internal::Type::Boolean
-
-        # @!attribute languages
-        #   A list of the languages used in the show, identified by their
-        #   [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
-        #
-        #   @return [Array<String>]
-        required :languages, Spotted::Internal::Type::ArrayOf[String]
-
-        # @!attribute media_type
-        #   The media type of the show.
-        #
-        #   @return [String]
-        required :media_type, String
-
-        # @!attribute name
-        #   The name of the episode.
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute publisher
-        #   The publisher of the show.
-        #
-        #   @return [String]
-        required :publisher, String
-
-        # @!attribute total_episodes
-        #   The total number of episodes in the show.
-        #
-        #   @return [Integer]
-        required :total_episodes, Integer
-
-        # @!attribute type
-        #   The object type.
-        #
-        #   @return [Symbol, Spotted::Models::EpisodeObject::Show::Type]
-        required :type, enum: -> { Spotted::EpisodeObject::Show::Type }
-
-        # @!attribute uri
-        #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
-        #   show.
-        #
-        #   @return [String]
-        required :uri, String
-
-        # @!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:)
-        #   Some parameter documentations has been truncated, see
-        #   {Spotted::Models::EpisodeObject::Show} for more details.
-        #
-        #   The show on which the episode belongs.
-        #
-        #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
-        #
-        #   @param available_markets [Array<String>] A list of the countries in which the show can be played, identified by their [IS
-        #
-        #   @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the show.
-        #
-        #   @param description [String] A description of the show. HTML tags are stripped away from this field, use `htm
-        #
-        #   @param explicit [Boolean] Whether or not the show has explicit content (true = yes it does; false = no it
-        #
-        #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this show.
-        #
-        #   @param href [String] A link to the Web API endpoint providing full details of the show.
-        #
-        #   @param html_description [String] A description of the show. This field may contain HTML tags.
-        #
-        #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the show in various sizes, widest first.
-        #
-        #   @param is_externally_hosted [Boolean] True if all of the shows episodes are hosted outside of Spotify's CDN. This fiel
-        #
-        #   @param languages [Array<String>] A list of the languages used in the show, identified by their [ISO 639](https://
-        #
-        #   @param media_type [String] The media type of the show.
-        #
-        #   @param name [String] The name of the episode.
-        #
-        #   @param publisher [String] The publisher of the show.
-        #
-        #   @param total_episodes [Integer] The total number of episodes in the show.
-        #
-        #   @param type [Symbol, Spotted::Models::EpisodeObject::Show::Type] The object type.
-        #
-        #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show
-
-        # The object type.
-        #
-        # @see Spotted::Models::EpisodeObject::Show#type
-        module Type
-          extend Spotted::Internal::Type::Enum
-
-          SHOW = :show
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       # The object type.
       #
       # @see Spotted::Models::EpisodeObject#type