spotted 0.1.0

data/rbi/spotted/models/audiobook_retrieve_response.rbi

@@ -0,0 +1,332 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class AudiobookRetrieveResponse < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Spotted::Models::AudiobookRetrieveResponse,
+            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 chapters of the audiobook.
+      sig { returns(Spotted::Models::AudiobookRetrieveResponse::Chapters) }
+      attr_reader :chapters
+
+      sig do
+        params(
+          chapters: Spotted::Models::AudiobookRetrieveResponse::Chapters::OrHash
+        ).void
+      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::AudiobookRetrieveResponse::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::AudiobookRetrieveResponse::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::AudiobookRetrieveResponse::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 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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            authors: T::Array[Spotted::AuthorObject],
+            available_markets: T::Array[String],
+            chapters: Spotted::Models::AudiobookRetrieveResponse::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::AudiobookRetrieveResponse::Type::TaggedSymbol,
+            uri: String,
+            edition: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Chapters < Spotted::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Models::AudiobookRetrieveResponse::Chapters,
+              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::SimplifiedChapterObject]) }
+        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 chapters of the audiobook.
+        sig do
+          params(
+            href: String,
+            items: T::Array[Spotted::SimplifiedChapterObject::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::SimplifiedChapterObject],
+              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::AudiobookRetrieveResponse::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUDIOBOOK =
+          T.let(
+            :audiobook,
+            Spotted::Models::AudiobookRetrieveResponse::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Spotted::Models::AudiobookRetrieveResponse::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/author_object.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class AuthorObject < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::AuthorObject, Spotted::Internal::AnyHash)
+        end
+
+      # The name of the author.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      sig { params(name: String).returns(T.attached_class) }
+      def self.new(
+        # The name of the author.
+        name: nil
+      )
+      end
+
+      sig { override.returns({ name: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/spotted/models/browse/category_get_playlists_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Browse
+      class CategoryGetPlaylistsParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Browse::CategoryGetPlaylistsParams,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # The index of the first item to return. Default: 0 (the first item). Use with
+        # limit to get the next set of items.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :offset
+
+        sig { params(offset: Integer).void }
+        attr_writer :offset
+
+        sig do
+          params(
+            limit: Integer,
+            offset: Integer,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+          limit: nil,
+          # The index of the first item to return. Default: 0 (the first item). Use with
+          # limit to get the next set of items.
+          offset: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              limit: Integer,
+              offset: Integer,
+              request_options: Spotted::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/browse/category_get_playlists_response.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Browse
+      class CategoryGetPlaylistsResponse < Spotted::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Models::Browse::CategoryGetPlaylistsResponse,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # The localized message of a playlist.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        sig { returns(T.nilable(Spotted::PagingPlaylistObject)) }
+        attr_reader :playlists
+
+        sig { params(playlists: Spotted::PagingPlaylistObject::OrHash).void }
+        attr_writer :playlists
+
+        sig do
+          params(
+            message: String,
+            playlists: Spotted::PagingPlaylistObject::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The localized message of a playlist.
+          message: nil,
+          playlists: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { message: String, playlists: Spotted::PagingPlaylistObject }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/browse/category_list_params.rbi

@@ -0,0 +1,89 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Browse
+      class CategoryListParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Browse::CategoryListParams,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # The desired language, consisting of an
+        # [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code and an
+        # [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2),
+        # joined by an underscore. For example: `es_MX`, meaning &quot;Spanish
+        # (Mexico)&quot;. Provide this parameter if you want the category strings returned
+        # in a particular language.<br/> _**Note**: if `locale` is not supplied, or if the
+        # specified language is not available, the category strings returned will be in
+        # the Spotify default language (American English)._
+        sig { returns(T.nilable(String)) }
+        attr_reader :locale
+
+        sig { params(locale: String).void }
+        attr_writer :locale
+
+        # The index of the first item to return. Default: 0 (the first item). Use with
+        # limit to get the next set of items.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :offset
+
+        sig { params(offset: Integer).void }
+        attr_writer :offset
+
+        sig do
+          params(
+            limit: Integer,
+            locale: String,
+            offset: Integer,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+          limit: nil,
+          # The desired language, consisting of an
+          # [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code and an
+          # [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2),
+          # joined by an underscore. For example: `es_MX`, meaning &quot;Spanish
+          # (Mexico)&quot;. Provide this parameter if you want the category strings returned
+          # in a particular language.<br/> _**Note**: if `locale` is not supplied, or if the
+          # specified language is not available, the category strings returned will be in
+          # the Spotify default language (American English)._
+          locale: nil,
+          # The index of the first item to return. Default: 0 (the first item). Use with
+          # limit to get the next set of items.
+          offset: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              limit: Integer,
+              locale: String,
+              offset: Integer,
+              request_options: Spotted::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end