spotted 0.1.0

data/rbi/spotted/models/chapter_list_response.rbi

@@ -0,0 +1,588 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class ChapterListResponse < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Spotted::Models::ChapterListResponse,
+            Spotted::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[Spotted::Models::ChapterListResponse::Chapter]) }
+      attr_accessor :chapters
+
+      sig do
+        params(
+          chapters:
+            T::Array[Spotted::Models::ChapterListResponse::Chapter::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(chapters:)
+      end
+
+      sig do
+        override.returns(
+          { chapters: T::Array[Spotted::Models::ChapterListResponse::Chapter] }
+        )
+      end
+      def to_hash
+      end
+
+      class Chapter < Spotted::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Models::ChapterListResponse::Chapter,
+              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 audiobook for which the chapter belongs.
+        sig do
+          returns(Spotted::Models::ChapterListResponse::Chapter::Audiobook)
+        end
+        attr_reader :audiobook
+
+        sig do
+          params(
+            audiobook:
+              Spotted::Models::ChapterListResponse::Chapter::Audiobook::OrHash
+          ).void
+        end
+        attr_writer :audiobook
+
+        # 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::Models::ChapterListResponse::Chapter::ReleaseDatePrecision::TaggedSymbol
+          )
+        end
+        attr_accessor :release_date_precision
+
+        # The object type.
+        sig do
+          returns(
+            Spotted::Models::ChapterListResponse::Chapter::Type::TaggedSymbol
+          )
+        end
+        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),
+            audiobook:
+              Spotted::Models::ChapterListResponse::Chapter::Audiobook::OrHash,
+            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::Models::ChapterListResponse::Chapter::ReleaseDatePrecision::OrSymbol,
+            type: Spotted::Models::ChapterListResponse::Chapter::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 audiobook for which the chapter belongs.
+          audiobook:,
+          # 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),
+              audiobook:
+                Spotted::Models::ChapterListResponse::Chapter::Audiobook,
+              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::Models::ChapterListResponse::Chapter::ReleaseDatePrecision::TaggedSymbol,
+              type:
+                Spotted::Models::ChapterListResponse::Chapter::Type::TaggedSymbol,
+              uri: String,
+              available_markets: T::Array[String],
+              restrictions: Spotted::ChapterRestrictionObject,
+              resume_point: Spotted::ResumePointObject
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Audiobook < Spotted::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Spotted::Models::ChapterListResponse::Chapter::Audiobook,
+                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 do
+            returns(
+              Spotted::Models::ChapterListResponse::Chapter::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
+
+          # The audiobook for which the chapter belongs.
+          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::Models::ChapterListResponse::Chapter::Audiobook::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::Models::ChapterListResponse::Chapter::Audiobook::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 do
+                T.all(
+                  Symbol,
+                  Spotted::Models::ChapterListResponse::Chapter::Audiobook::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AUDIOBOOK =
+              T.let(
+                :audiobook,
+                Spotted::Models::ChapterListResponse::Chapter::Audiobook::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Spotted::Models::ChapterListResponse::Chapter::Audiobook::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        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::Models::ChapterListResponse::Chapter::ReleaseDatePrecision
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          YEAR =
+            T.let(
+              :year,
+              Spotted::Models::ChapterListResponse::Chapter::ReleaseDatePrecision::TaggedSymbol
+            )
+          MONTH =
+            T.let(
+              :month,
+              Spotted::Models::ChapterListResponse::Chapter::ReleaseDatePrecision::TaggedSymbol
+            )
+          DAY =
+            T.let(
+              :day,
+              Spotted::Models::ChapterListResponse::Chapter::ReleaseDatePrecision::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Spotted::Models::ChapterListResponse::Chapter::ReleaseDatePrecision::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The object type.
+        module Type
+          extend Spotted::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Spotted::Models::ChapterListResponse::Chapter::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EPISODE =
+            T.let(
+              :episode,
+              Spotted::Models::ChapterListResponse::Chapter::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Spotted::Models::ChapterListResponse::Chapter::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/chapter_restriction_object.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class ChapterRestrictionObject < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::ChapterRestrictionObject, Spotted::Internal::AnyHash)
+        end
+
+      # The reason for the restriction. Supported values:
+      #
+      # - `market` - The content item is not available in the given market.
+      # - `product` - The content item is not available for the user's subscription
+      #   type.
+      # - `explicit` - The content item is explicit and the user's account is set to not
+      #   play explicit content.
+      # - `payment_required` - Payment is required to play the content item.
+      #
+      # Additional reasons may be added in the future. **Note**: If you use this field,
+      # make sure that your application safely handles unknown values.
+      sig { returns(T.nilable(String)) }
+      attr_reader :reason
+
+      sig { params(reason: String).void }
+      attr_writer :reason
+
+      sig { params(reason: String).returns(T.attached_class) }
+      def self.new(
+        # The reason for the restriction. Supported values:
+        #
+        # - `market` - The content item is not available in the given market.
+        # - `product` - The content item is not available for the user's subscription
+        #   type.
+        # - `explicit` - The content item is explicit and the user's account is set to not
+        #   play explicit content.
+        # - `payment_required` - Payment is required to play the content item.
+        #
+        # Additional reasons may be added in the future. **Note**: If you use this field,
+        # make sure that your application safely handles unknown values.
+        reason: nil
+      )
+      end
+
+      sig { override.returns({ reason: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/spotted/models/chapter_retrieve_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class ChapterRetrieveParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::ChapterRetrieveParams, Spotted::Internal::AnyHash)
+        end
+
+      # An
+      # [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+      # If a country code is specified, only content that is available in that market
+      # will be returned.<br/> If a valid user access token is specified in the request
+      # header, the country associated with the user account will take priority over
+      # this parameter.<br/> _**Note**: If neither market or user country are provided,
+      # the content is considered unavailable for the client._<br/> Users can view the
+      # country that is associated with their account in the
+      # [account settings](https://www.spotify.com/account/overview/).
+      sig { returns(T.nilable(String)) }
+      attr_reader :market
+
+      sig { params(market: String).void }
+      attr_writer :market
+
+      sig do
+        params(
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # An
+        # [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+        # If a country code is specified, only content that is available in that market
+        # will be returned.<br/> If a valid user access token is specified in the request
+        # header, the country associated with the user account will take priority over
+        # this parameter.<br/> _**Note**: If neither market or user country are provided,
+        # the content is considered unavailable for the client._<br/> Users can view the
+        # country that is associated with their account in the
+        # [account settings](https://www.spotify.com/account/overview/).
+        market: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { market: String, request_options: Spotted::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end