spotted 0.1.0

data/rbi/spotted/models/show_retrieve_response.rbi

@@ -0,0 +1,305 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class ShowRetrieveResponse < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Spotted::Models::ShowRetrieveResponse,
+            Spotted::Internal::AnyHash
+          )
+        end
+
+      # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # 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.
+      sig { returns(T::Array[String]) }
+      attr_accessor :available_markets
+
+      # The copyright statements of the show.
+      sig { returns(T::Array[Spotted::CopyrightObject]) }
+      attr_accessor :copyrights
+
+      # A description of the show. HTML tags are stripped away from this field, use
+      # `html_description` field in case HTML tags are needed.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # The episodes of the show.
+      sig { returns(Spotted::Models::ShowRetrieveResponse::Episodes) }
+      attr_reader :episodes
+
+      sig do
+        params(
+          episodes: Spotted::Models::ShowRetrieveResponse::Episodes::OrHash
+        ).void
+      end
+      attr_writer :episodes
+
+      # Whether or not the show 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 show.
+      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 show.
+      sig { returns(String) }
+      attr_accessor :href
+
+      # A description of the show. This field may contain HTML tags.
+      sig { returns(String) }
+      attr_accessor :html_description
+
+      # The cover art for the show in various sizes, widest first.
+      sig { returns(T::Array[Spotted::ImageObject]) }
+      attr_accessor :images
+
+      # True if all of the shows episodes are hosted outside of Spotify's CDN. This
+      # field might be `null` in some cases.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_externally_hosted
+
+      # A list of the languages used in the show, 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 show.
+      sig { returns(String) }
+      attr_accessor :media_type
+
+      # The name of the episode.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The publisher of the show.
+      sig { returns(String) }
+      attr_accessor :publisher
+
+      # The total number of episodes in the show.
+      sig { returns(Integer) }
+      attr_accessor :total_episodes
+
+      # The object type.
+      sig { returns(Spotted::Models::ShowRetrieveResponse::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # show.
+      sig { returns(String) }
+      attr_accessor :uri
+
+      sig do
+        params(
+          id: String,
+          available_markets: T::Array[String],
+          copyrights: T::Array[Spotted::CopyrightObject::OrHash],
+          description: String,
+          episodes: Spotted::Models::ShowRetrieveResponse::Episodes::OrHash,
+          explicit: T::Boolean,
+          external_urls: Spotted::ExternalURLObject::OrHash,
+          href: String,
+          html_description: String,
+          images: T::Array[Spotted::ImageObject::OrHash],
+          is_externally_hosted: T::Boolean,
+          languages: T::Array[String],
+          media_type: String,
+          name: String,
+          publisher: String,
+          total_episodes: Integer,
+          type: Spotted::Models::ShowRetrieveResponse::Type::OrSymbol,
+          uri: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
+        id:,
+        # 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.
+        available_markets:,
+        # The copyright statements of the show.
+        copyrights:,
+        # A description of the show. HTML tags are stripped away from this field, use
+        # `html_description` field in case HTML tags are needed.
+        description:,
+        # The episodes of the show.
+        episodes:,
+        # Whether or not the show has explicit content (true = yes it does; false = no it
+        # does not OR unknown).
+        explicit:,
+        # External URLs for this show.
+        external_urls:,
+        # A link to the Web API endpoint providing full details of the show.
+        href:,
+        # A description of the show. This field may contain HTML tags.
+        html_description:,
+        # The cover art for the show in various sizes, widest first.
+        images:,
+        # True if all of the shows episodes are hosted outside of Spotify's CDN. This
+        # field might be `null` in some cases.
+        is_externally_hosted:,
+        # A list of the languages used in the show, identified by their
+        # [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
+        languages:,
+        # The media type of the show.
+        media_type:,
+        # The name of the episode.
+        name:,
+        # The publisher of the show.
+        publisher:,
+        # The total number of episodes in the show.
+        total_episodes:,
+        # The object type.
+        type:,
+        # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # show.
+        uri:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            available_markets: T::Array[String],
+            copyrights: T::Array[Spotted::CopyrightObject],
+            description: String,
+            episodes: Spotted::Models::ShowRetrieveResponse::Episodes,
+            explicit: T::Boolean,
+            external_urls: Spotted::ExternalURLObject,
+            href: String,
+            html_description: String,
+            images: T::Array[Spotted::ImageObject],
+            is_externally_hosted: T::Boolean,
+            languages: T::Array[String],
+            media_type: String,
+            name: String,
+            publisher: String,
+            total_episodes: Integer,
+            type: Spotted::Models::ShowRetrieveResponse::Type::TaggedSymbol,
+            uri: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Episodes < Spotted::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Models::ShowRetrieveResponse::Episodes,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # A link to the Web API endpoint returning the full result of the request
+        sig { returns(String) }
+        attr_accessor :href
+
+        sig { returns(T::Array[Spotted::SimplifiedEpisodeObject]) }
+        attr_accessor :items
+
+        # The maximum number of items in the response (as set in the query or by default).
+        sig { returns(Integer) }
+        attr_accessor :limit
+
+        # URL to the next page of items. ( `null` if none)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_
+
+        # The offset of the items returned (as set in the query or by default)
+        sig { returns(Integer) }
+        attr_accessor :offset
+
+        # URL to the previous page of items. ( `null` if none)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :previous
+
+        # The total number of items available to return.
+        sig { returns(Integer) }
+        attr_accessor :total
+
+        # The episodes of the show.
+        sig do
+          params(
+            href: String,
+            items: T::Array[Spotted::SimplifiedEpisodeObject::OrHash],
+            limit: Integer,
+            next_: T.nilable(String),
+            offset: Integer,
+            previous: T.nilable(String),
+            total: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A link to the Web API endpoint returning the full result of the request
+          href:,
+          items:,
+          # The maximum number of items in the response (as set in the query or by default).
+          limit:,
+          # URL to the next page of items. ( `null` if none)
+          next_:,
+          # The offset of the items returned (as set in the query or by default)
+          offset:,
+          # URL to the previous page of items. ( `null` if none)
+          previous:,
+          # The total number of items available to return.
+          total:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              href: String,
+              items: T::Array[Spotted::SimplifiedEpisodeObject],
+              limit: Integer,
+              next_: T.nilable(String),
+              offset: Integer,
+              previous: T.nilable(String),
+              total: Integer
+            }
+          )
+        end
+        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::ShowRetrieveResponse::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SHOW =
+          T.let(
+            :show,
+            Spotted::Models::ShowRetrieveResponse::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Spotted::Models::ShowRetrieveResponse::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/simplified_artist_object.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class SimplifiedArtistObject < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::SimplifiedArtistObject, Spotted::Internal::AnyHash)
+        end
+
+      # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # artist.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Known external URLs for this artist.
+      sig { returns(T.nilable(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 artist.
+      sig { returns(T.nilable(String)) }
+      attr_reader :href
+
+      sig { params(href: String).void }
+      attr_writer :href
+
+      # The name of the artist.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # The object type.
+      sig do
+        returns(T.nilable(Spotted::SimplifiedArtistObject::Type::TaggedSymbol))
+      end
+      attr_reader :type
+
+      sig { params(type: Spotted::SimplifiedArtistObject::Type::OrSymbol).void }
+      attr_writer :type
+
+      # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # artist.
+      sig { returns(T.nilable(String)) }
+      attr_reader :uri
+
+      sig { params(uri: String).void }
+      attr_writer :uri
+
+      sig do
+        params(
+          id: String,
+          external_urls: Spotted::ExternalURLObject::OrHash,
+          href: String,
+          name: String,
+          type: Spotted::SimplifiedArtistObject::Type::OrSymbol,
+          uri: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # artist.
+        id: nil,
+        # Known external URLs for this artist.
+        external_urls: nil,
+        # A link to the Web API endpoint providing full details of the artist.
+        href: nil,
+        # The name of the artist.
+        name: nil,
+        # The object type.
+        type: nil,
+        # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # artist.
+        uri: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            external_urls: Spotted::ExternalURLObject,
+            href: String,
+            name: String,
+            type: Spotted::SimplifiedArtistObject::Type::TaggedSymbol,
+            uri: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The object type.
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Spotted::SimplifiedArtistObject::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ARTIST =
+          T.let(:artist, Spotted::SimplifiedArtistObject::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Spotted::SimplifiedArtistObject::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/simplified_chapter_object.rbi

@@ -0,0 +1,287 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class SimplifiedChapterObject < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::SimplifiedChapterObject, Spotted::Internal::AnyHash)
+        end
+
+      # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # chapter.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # A URL to a 30 second preview (MP3 format) of the chapter. `null` if not
+      # available.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :audio_preview_url
+
+      # The number of the chapter
+      sig { returns(Integer) }
+      attr_accessor :chapter_number
+
+      # A description of the chapter. HTML tags are stripped away from this field, use
+      # `html_description` field in case HTML tags are needed.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # The chapter length in milliseconds.
+      sig { returns(Integer) }
+      attr_accessor :duration_ms
+
+      # Whether or not the chapter 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 chapter.
+      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 chapter.
+      sig { returns(String) }
+      attr_accessor :href
+
+      # A description of the chapter. This field may contain HTML tags.
+      sig { returns(String) }
+      attr_accessor :html_description
+
+      # The cover art for the chapter in various sizes, widest first.
+      sig { returns(T::Array[Spotted::ImageObject]) }
+      attr_accessor :images
+
+      # True if the chapter is playable in the given market. Otherwise false.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_playable
+
+      # A list of the languages used in the chapter, identified by their
+      # [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code.
+      sig { returns(T::Array[String]) }
+      attr_accessor :languages
+
+      # The name of the chapter.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The date the chapter was first released, for example `"1981-12-15"`. Depending
+      # on the precision, it might be shown as `"1981"` or `"1981-12"`.
+      sig { returns(String) }
+      attr_accessor :release_date
+
+      # The precision with which `release_date` value is known.
+      sig do
+        returns(
+          Spotted::SimplifiedChapterObject::ReleaseDatePrecision::TaggedSymbol
+        )
+      end
+      attr_accessor :release_date_precision
+
+      # The object type.
+      sig { returns(Spotted::SimplifiedChapterObject::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # chapter.
+      sig { returns(String) }
+      attr_accessor :uri
+
+      # A list of the countries in which the chapter 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.nilable(T::Array[String])) }
+      attr_reader :available_markets
+
+      sig { params(available_markets: T::Array[String]).void }
+      attr_writer :available_markets
+
+      # Included in the response when a content restriction is applied.
+      sig { returns(T.nilable(Spotted::ChapterRestrictionObject)) }
+      attr_reader :restrictions
+
+      sig do
+        params(restrictions: Spotted::ChapterRestrictionObject::OrHash).void
+      end
+      attr_writer :restrictions
+
+      # The user's most recent position in the chapter. Set if the supplied access token
+      # is a user token and has the scope 'user-read-playback-position'.
+      sig { returns(T.nilable(Spotted::ResumePointObject)) }
+      attr_reader :resume_point
+
+      sig { params(resume_point: Spotted::ResumePointObject::OrHash).void }
+      attr_writer :resume_point
+
+      sig do
+        params(
+          id: String,
+          audio_preview_url: T.nilable(String),
+          chapter_number: Integer,
+          description: String,
+          duration_ms: Integer,
+          explicit: T::Boolean,
+          external_urls: Spotted::ExternalURLObject::OrHash,
+          href: String,
+          html_description: String,
+          images: T::Array[Spotted::ImageObject::OrHash],
+          is_playable: T::Boolean,
+          languages: T::Array[String],
+          name: String,
+          release_date: String,
+          release_date_precision:
+            Spotted::SimplifiedChapterObject::ReleaseDatePrecision::OrSymbol,
+          type: Spotted::SimplifiedChapterObject::Type::OrSymbol,
+          uri: String,
+          available_markets: T::Array[String],
+          restrictions: Spotted::ChapterRestrictionObject::OrHash,
+          resume_point: Spotted::ResumePointObject::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # chapter.
+        id:,
+        # A URL to a 30 second preview (MP3 format) of the chapter. `null` if not
+        # available.
+        audio_preview_url:,
+        # The number of the chapter
+        chapter_number:,
+        # A description of the chapter. HTML tags are stripped away from this field, use
+        # `html_description` field in case HTML tags are needed.
+        description:,
+        # The chapter length in milliseconds.
+        duration_ms:,
+        # Whether or not the chapter has explicit content (true = yes it does; false = no
+        # it does not OR unknown).
+        explicit:,
+        # External URLs for this chapter.
+        external_urls:,
+        # A link to the Web API endpoint providing full details of the chapter.
+        href:,
+        # A description of the chapter. This field may contain HTML tags.
+        html_description:,
+        # The cover art for the chapter in various sizes, widest first.
+        images:,
+        # True if the chapter is playable in the given market. Otherwise false.
+        is_playable:,
+        # A list of the languages used in the chapter, identified by their
+        # [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code.
+        languages:,
+        # The name of the chapter.
+        name:,
+        # The date the chapter was first released, for example `"1981-12-15"`. Depending
+        # on the precision, it might be shown as `"1981"` or `"1981-12"`.
+        release_date:,
+        # The precision with which `release_date` value is known.
+        release_date_precision:,
+        # The object type.
+        type:,
+        # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # chapter.
+        uri:,
+        # A list of the countries in which the chapter can be played, identified by their
+        # [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+        available_markets: nil,
+        # Included in the response when a content restriction is applied.
+        restrictions: nil,
+        # The user's most recent position in the chapter. Set if the supplied access token
+        # is a user token and has the scope 'user-read-playback-position'.
+        resume_point: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            audio_preview_url: T.nilable(String),
+            chapter_number: Integer,
+            description: String,
+            duration_ms: Integer,
+            explicit: T::Boolean,
+            external_urls: Spotted::ExternalURLObject,
+            href: String,
+            html_description: String,
+            images: T::Array[Spotted::ImageObject],
+            is_playable: T::Boolean,
+            languages: T::Array[String],
+            name: String,
+            release_date: String,
+            release_date_precision:
+              Spotted::SimplifiedChapterObject::ReleaseDatePrecision::TaggedSymbol,
+            type: Spotted::SimplifiedChapterObject::Type::TaggedSymbol,
+            uri: String,
+            available_markets: T::Array[String],
+            restrictions: Spotted::ChapterRestrictionObject,
+            resume_point: Spotted::ResumePointObject
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The precision with which `release_date` value is known.
+      module ReleaseDatePrecision
+        extend Spotted::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Spotted::SimplifiedChapterObject::ReleaseDatePrecision
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        YEAR =
+          T.let(
+            :year,
+            Spotted::SimplifiedChapterObject::ReleaseDatePrecision::TaggedSymbol
+          )
+        MONTH =
+          T.let(
+            :month,
+            Spotted::SimplifiedChapterObject::ReleaseDatePrecision::TaggedSymbol
+          )
+        DAY =
+          T.let(
+            :day,
+            Spotted::SimplifiedChapterObject::ReleaseDatePrecision::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Spotted::SimplifiedChapterObject::ReleaseDatePrecision::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The object type.
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Spotted::SimplifiedChapterObject::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EPISODE =
+          T.let(:episode, Spotted::SimplifiedChapterObject::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Spotted::SimplifiedChapterObject::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end