spotted 0.1.0 → 0.2.0

data/lib/spotted/models/search_retrieve_response.rb

@@ -349,9 +349,8 @@ module Spotted
 
         # @!attribute items
         #
-        #   @return [Array<Spotted::Models::SearchRetrieveResponse::Audiobooks::Item>]
-        required :items,
-                 -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::SearchRetrieveResponse::Audiobooks::Item] }
+        #   @return [Array<Spotted::Models::AudiobookBase>]
+        required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::AudiobookBase] }
 
         # @!attribute limit
         #   The maximum number of items in the response (as set in the query or by default).
@@ -389,7 +388,7 @@ module Spotted
         #
         #   @param href [String] A link to the Web API endpoint returning the full result of the request
         #
-        #   @param items [Array<Spotted::Models::SearchRetrieveResponse::Audiobooks::Item>]
+        #   @param items [Array<Spotted::Models::AudiobookBase>]
         #
         #   @param limit [Integer] The maximum number of items in the response (as set in the query or by default).
         #
@@ -400,183 +399,6 @@ module Spotted
         #   @param previous [String, nil] URL to the previous page of items. ( `null` if none)
         #
         #   @param total [Integer] The total number of items available to return.
-
-        class Item < 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::SearchRetrieveResponse::Audiobooks::Item::Type]
-          required :type, enum: -> { Spotted::Models::SearchRetrieveResponse::Audiobooks::Item::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::SearchRetrieveResponse::Audiobooks::Item} for more details.
-          #
-          #   @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::SearchRetrieveResponse::Audiobooks::Item::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::SearchRetrieveResponse::Audiobooks::Item#type
-          module Type
-            extend Spotted::Internal::Type::Enum
-
-            AUDIOBOOK = :audiobook
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
       end
 
       # @see Spotted::Models::SearchRetrieveResponse#episodes
@@ -651,9 +473,8 @@ module Spotted
 
         # @!attribute items
         #
-        #   @return [Array<Spotted::Models::SearchRetrieveResponse::Shows::Item>]
-        required :items,
-                 -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::SearchRetrieveResponse::Shows::Item] }
+        #   @return [Array<Spotted::Models::ShowBase>]
+        required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::ShowBase] }
 
         # @!attribute limit
         #   The maximum number of items in the response (as set in the query or by default).
@@ -691,7 +512,7 @@ module Spotted
         #
         #   @param href [String] A link to the Web API endpoint returning the full result of the request
         #
-        #   @param items [Array<Spotted::Models::SearchRetrieveResponse::Shows::Item>]
+        #   @param items [Array<Spotted::Models::ShowBase>]
         #
         #   @param limit [Integer] The maximum number of items in the response (as set in the query or by default).
         #
@@ -702,166 +523,6 @@ module Spotted
         #   @param previous [String, nil] URL to the previous page of items. ( `null` if none)
         #
         #   @param total [Integer] The total number of items available to return.
-
-        class Item < 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::SearchRetrieveResponse::Shows::Item::Type]
-          required :type, enum: -> { Spotted::Models::SearchRetrieveResponse::Shows::Item::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::SearchRetrieveResponse::Shows::Item} for more details.
-          #
-          #   @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::SearchRetrieveResponse::Shows::Item::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::SearchRetrieveResponse::Shows::Item#type
-          module Type
-            extend Spotted::Internal::Type::Enum
-
-            SHOW = :show
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
       end
 
       # @see Spotted::Models::SearchRetrieveResponse#tracks

data/lib/spotted/models/show_base.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class ShowBase < 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::ShowBase::Type]
+      required :type, enum: -> { Spotted::ShowBase::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::ShowBase} for more details.
+      #
+      #   @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::ShowBase::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::ShowBase#type
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        SHOW = :show
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end