spotted 0.1.0

data/rbi/spotted/models/show_list_episodes_params.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class ShowListEpisodesParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::ShowListEpisodesParams, 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
+
+      # 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
+
+      # 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,
+          market: 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,
+        # 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,
+        # 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,
+            market: String,
+            offset: Integer,
+            request_options: Spotted::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/spotted/models/show_list_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class ShowListParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::ShowListParams, Spotted::Internal::AnyHash)
+        end
+
+      # A comma-separated list of the
+      # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the shows.
+      # Maximum: 50 IDs.
+      sig { returns(String) }
+      attr_accessor :ids
+
+      # 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(
+          ids: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A comma-separated list of the
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the shows.
+        # Maximum: 50 IDs.
+        ids:,
+        # 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(
+          {
+            ids: String,
+            market: String,
+            request_options: Spotted::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/spotted/models/show_list_response.rbi

@@ -0,0 +1,238 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class ShowListResponse < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::Models::ShowListResponse, Spotted::Internal::AnyHash)
+        end
+
+      sig { returns(T::Array[Spotted::Models::ShowListResponse::Show]) }
+      attr_accessor :shows
+
+      sig do
+        params(
+          shows: T::Array[Spotted::Models::ShowListResponse::Show::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(shows:)
+      end
+
+      sig do
+        override.returns(
+          { shows: T::Array[Spotted::Models::ShowListResponse::Show] }
+        )
+      end
+      def to_hash
+      end
+
+      class Show < Spotted::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Models::ShowListResponse::Show,
+              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
+
+        # 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 do
+          returns(Spotted::Models::ShowListResponse::Show::Type::TaggedSymbol)
+        end
+        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,
+            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::ShowListResponse::Show::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:,
+          # 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,
+              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::ShowListResponse::Show::Type::TaggedSymbol,
+              uri: 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::ShowListResponse::Show::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SHOW =
+            T.let(
+              :show,
+              Spotted::Models::ShowListResponse::Show::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Spotted::Models::ShowListResponse::Show::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/show_retrieve_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class ShowRetrieveParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::ShowRetrieveParams, 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