spotted 0.1.0 → 0.2.0

data/lib/spotted/models/show_list_response.rb

@@ -6,171 +6,11 @@ module Spotted
     class ShowListResponse < Spotted::Internal::Type::BaseModel
       # @!attribute shows
       #
-      #   @return [Array<Spotted::Models::ShowListResponse::Show>]
-      required :shows, -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::ShowListResponse::Show] }
+      #   @return [Array<Spotted::Models::ShowBase>]
+      required :shows, -> { Spotted::Internal::Type::ArrayOf[Spotted::ShowBase] }
 
       # @!method initialize(shows:)
-      #   @param shows [Array<Spotted::Models::ShowListResponse::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::ShowListResponse::Show::Type]
-        required :type, enum: -> { Spotted::Models::ShowListResponse::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::ShowListResponse::Show} 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::ShowListResponse::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::ShowListResponse::Show#type
-        module Type
-          extend Spotted::Internal::Type::Enum
-
-          SHOW = :show
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
+      #   @param shows [Array<Spotted::Models::ShowBase>]
     end
   end
 end

data/lib/spotted/models/show_retrieve_response.rb

@@ -3,162 +3,19 @@
 module Spotted
   module Models
     # @see Spotted::Resources::Shows#retrieve
-    class ShowRetrieveResponse < 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
-
+    class ShowRetrieveResponse < Spotted::Models::ShowBase
       # @!attribute episodes
       #   The episodes of the show.
       #
       #   @return [Spotted::Models::ShowRetrieveResponse::Episodes]
       required :episodes, -> { Spotted::Models::ShowRetrieveResponse::Episodes }
 
-      # @!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::ShowRetrieveResponse::Type]
-      required :type, enum: -> { Spotted::Models::ShowRetrieveResponse::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:, episodes:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, languages:, media_type:, name:, publisher:, total_episodes:, type:, uri:)
+      # @!method initialize(episodes:)
       #   Some parameter documentations has been truncated, see
       #   {Spotted::Models::ShowRetrieveResponse} 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 episodes [Spotted::Models::ShowRetrieveResponse::Episodes] The episodes of the show.
-      #
-      #   @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::ShowRetrieveResponse::Type] The object type.
-      #
-      #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show
 
-      # @see Spotted::Models::ShowRetrieveResponse#episodes
       class Episodes < Spotted::Internal::Type::BaseModel
         # @!attribute href
         #   A link to the Web API endpoint returning the full result of the request
@@ -221,18 +78,6 @@ module Spotted
         #
         #   @param total [Integer] The total number of items available to return.
       end
-
-      # The object type.
-      #
-      # @see Spotted::Models::ShowRetrieveResponse#type
-      module Type
-        extend Spotted::Internal::Type::Enum
-
-        SHOW = :show
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/spotted/models.rb

@@ -61,6 +61,8 @@ module Spotted
 
   AudioAnalysisRetrieveParams = Spotted::Models::AudioAnalysisRetrieveParams
 
+  AudiobookBase = Spotted::Models::AudiobookBase
+
   AudiobookListChaptersParams = Spotted::Models::AudiobookListChaptersParams
 
   AudiobookListParams = Spotted::Models::AudiobookListParams
@@ -136,6 +138,8 @@ module Spotted
 
   SearchRetrieveParams = Spotted::Models::SearchRetrieveParams
 
+  ShowBase = Spotted::Models::ShowBase
+
   ShowListEpisodesParams = Spotted::Models::ShowListEpisodesParams
 
   ShowListParams = Spotted::Models::ShowListParams

data/lib/spotted/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotted
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/spotted.rb

@@ -54,7 +54,9 @@ require_relative "spotted/internal/transport/pooled_net_requester"
 require_relative "spotted/client"
 require_relative "spotted/internal/oauth2"
 require_relative "spotted/internal/cursor_url_page"
+require_relative "spotted/models/audiobook_base"
 require_relative "spotted/models/playlist_user_object"
+require_relative "spotted/models/show_base"
 require_relative "spotted/models/album_list_params"
 require_relative "spotted/models/album_list_response"
 require_relative "spotted/models/album_list_tracks_params"

data/rbi/spotted/models/audiobook_base.rbi

@@ -0,0 +1,219 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class AudiobookBase < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::AudiobookBase, Spotted::Internal::AnyHash)
+        end
+
+      # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # audiobook.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The author(s) for the audiobook.
+      sig { returns(T::Array[Spotted::AuthorObject]) }
+      attr_accessor :authors
+
+      # 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.
+      sig { returns(T::Array[String]) }
+      attr_accessor :available_markets
+
+      # The copyright statements of the audiobook.
+      sig { returns(T::Array[Spotted::CopyrightObject]) }
+      attr_accessor :copyrights
+
+      # A description of the audiobook. HTML tags are stripped away from this field, use
+      # `html_description` field in case HTML tags are needed.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # Whether or not the audiobook has explicit content (true = yes it does; false =
+      # no it does not OR unknown).
+      sig { returns(T::Boolean) }
+      attr_accessor :explicit
+
+      # External URLs for this audiobook.
+      sig { returns(Spotted::ExternalURLObject) }
+      attr_reader :external_urls
+
+      sig { params(external_urls: Spotted::ExternalURLObject::OrHash).void }
+      attr_writer :external_urls
+
+      # A link to the Web API endpoint providing full details of the audiobook.
+      sig { returns(String) }
+      attr_accessor :href
+
+      # A description of the audiobook. This field may contain HTML tags.
+      sig { returns(String) }
+      attr_accessor :html_description
+
+      # The cover art for the audiobook in various sizes, widest first.
+      sig { returns(T::Array[Spotted::ImageObject]) }
+      attr_accessor :images
+
+      # A list of the languages used in the audiobook, identified by their
+      # [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
+      sig { returns(T::Array[String]) }
+      attr_accessor :languages
+
+      # The media type of the audiobook.
+      sig { returns(String) }
+      attr_accessor :media_type
+
+      # The name of the audiobook.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The narrator(s) for the audiobook.
+      sig { returns(T::Array[Spotted::NarratorObject]) }
+      attr_accessor :narrators
+
+      # The publisher of the audiobook.
+      sig { returns(String) }
+      attr_accessor :publisher
+
+      # The number of chapters in this audiobook.
+      sig { returns(Integer) }
+      attr_accessor :total_chapters
+
+      # The object type.
+      sig { returns(Spotted::AudiobookBase::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # audiobook.
+      sig { returns(String) }
+      attr_accessor :uri
+
+      # The edition of the audiobook.
+      sig { returns(T.nilable(String)) }
+      attr_reader :edition
+
+      sig { params(edition: String).void }
+      attr_writer :edition
+
+      sig do
+        params(
+          id: String,
+          authors: T::Array[Spotted::AuthorObject::OrHash],
+          available_markets: T::Array[String],
+          copyrights: T::Array[Spotted::CopyrightObject::OrHash],
+          description: String,
+          explicit: T::Boolean,
+          external_urls: Spotted::ExternalURLObject::OrHash,
+          href: String,
+          html_description: String,
+          images: T::Array[Spotted::ImageObject::OrHash],
+          languages: T::Array[String],
+          media_type: String,
+          name: String,
+          narrators: T::Array[Spotted::NarratorObject::OrHash],
+          publisher: String,
+          total_chapters: Integer,
+          type: Spotted::AudiobookBase::Type::OrSymbol,
+          uri: String,
+          edition: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # audiobook.
+        id:,
+        # The author(s) for the audiobook.
+        authors:,
+        # 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.
+        available_markets:,
+        # The copyright statements of the audiobook.
+        copyrights:,
+        # A description of the audiobook. HTML tags are stripped away from this field, use
+        # `html_description` field in case HTML tags are needed.
+        description:,
+        # Whether or not the audiobook has explicit content (true = yes it does; false =
+        # no it does not OR unknown).
+        explicit:,
+        # External URLs for this audiobook.
+        external_urls:,
+        # A link to the Web API endpoint providing full details of the audiobook.
+        href:,
+        # A description of the audiobook. This field may contain HTML tags.
+        html_description:,
+        # The cover art for the audiobook in various sizes, widest first.
+        images:,
+        # A list of the languages used in the audiobook, identified by their
+        # [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
+        languages:,
+        # The media type of the audiobook.
+        media_type:,
+        # The name of the audiobook.
+        name:,
+        # The narrator(s) for the audiobook.
+        narrators:,
+        # The publisher of the audiobook.
+        publisher:,
+        # The number of chapters in this audiobook.
+        total_chapters:,
+        # The object type.
+        type:,
+        # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # audiobook.
+        uri:,
+        # The edition of the audiobook.
+        edition: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            authors: T::Array[Spotted::AuthorObject],
+            available_markets: T::Array[String],
+            copyrights: T::Array[Spotted::CopyrightObject],
+            description: String,
+            explicit: T::Boolean,
+            external_urls: Spotted::ExternalURLObject,
+            href: String,
+            html_description: String,
+            images: T::Array[Spotted::ImageObject],
+            languages: T::Array[String],
+            media_type: String,
+            name: String,
+            narrators: T::Array[Spotted::NarratorObject],
+            publisher: String,
+            total_chapters: Integer,
+            type: Spotted::AudiobookBase::Type::TaggedSymbol,
+            uri: String,
+            edition: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The object type.
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Spotted::AudiobookBase::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUDIOBOOK =
+          T.let(:audiobook, Spotted::AudiobookBase::Type::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Spotted::AudiobookBase::Type::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end