spotted 0.1.0 → 0.3.0

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

data/rbi/spotted/models/audiobook_list_response.rbi

@@ -36,7 +36,7 @@ module Spotted
       def to_hash
       end
 
-      class Audiobook < Spotted::Internal::Type::BaseModel
+      class Audiobook < Spotted::Models::AudiobookBase
         OrHash =
           T.type_alias do
             T.any(
@@ -45,21 +45,6 @@ module Spotted
             )
           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 chapters of the audiobook.
         sig do
           returns(Spotted::Models::AudiobookListResponse::Audiobook::Chapters)
@@ -74,186 +59,23 @@ module Spotted
         end
         attr_writer :chapters
 
-        # 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 do
-          returns(
-            Spotted::Models::AudiobookListResponse::Audiobook::Type::TaggedSymbol
-          )
-        end
-        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],
             chapters:
-              Spotted::Models::AudiobookListResponse::Audiobook::Chapters::OrHash,
-            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::Models::AudiobookListResponse::Audiobook::Type::OrSymbol,
-            uri: String,
-            edition: String
+              Spotted::Models::AudiobookListResponse::Audiobook::Chapters::OrHash
           ).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 chapters of the audiobook.
-          chapters:,
-          # 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
+          chapters:
         )
         end
 
         sig do
           override.returns(
             {
-              id: String,
-              authors: T::Array[Spotted::AuthorObject],
-              available_markets: T::Array[String],
               chapters:
-                Spotted::Models::AudiobookListResponse::Audiobook::Chapters,
-              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::Models::AudiobookListResponse::Audiobook::Type::TaggedSymbol,
-              uri: String,
-              edition: String
+                Spotted::Models::AudiobookListResponse::Audiobook::Chapters
             }
           )
         end
@@ -341,36 +163,6 @@ module Spotted
           def to_hash
           end
         end
-
-        # The object type.
-        module Type
-          extend Spotted::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Spotted::Models::AudiobookListResponse::Audiobook::Type
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          AUDIOBOOK =
-            T.let(
-              :audiobook,
-              Spotted::Models::AudiobookListResponse::Audiobook::Type::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Spotted::Models::AudiobookListResponse::Audiobook::Type::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
       end
     end
   end