spotted 0.1.0

data/rbi/spotted/models/me/device_object.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Me
+      class DeviceObject < Spotted::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Spotted::Me::DeviceObject, Spotted::Internal::AnyHash)
+          end
+
+        # The device ID. This ID is unique and persistent to some extent. However, this is
+        # not guaranteed and any cached `device_id` should periodically be cleared out and
+        # refetched as necessary.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # If this device is the currently active device.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_active
+
+        sig { params(is_active: T::Boolean).void }
+        attr_writer :is_active
+
+        # If this device is currently in a private session.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_private_session
+
+        sig { params(is_private_session: T::Boolean).void }
+        attr_writer :is_private_session
+
+        # Whether controlling this device is restricted. At present if this is "true" then
+        # no Web API commands will be accepted by this device.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_restricted
+
+        sig { params(is_restricted: T::Boolean).void }
+        attr_writer :is_restricted
+
+        # A human-readable name for the device. Some devices have a name that the user can
+        # configure (e.g. \"Loudest speaker\") and some devices have a generic name
+        # associated with the manufacturer or device model.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # If this device can be used to set the volume.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :supports_volume
+
+        sig { params(supports_volume: T::Boolean).void }
+        attr_writer :supports_volume
+
+        # Device type, such as "computer", "smartphone" or "speaker".
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        # The current volume in percent.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :volume_percent
+
+        sig do
+          params(
+            id: T.nilable(String),
+            is_active: T::Boolean,
+            is_private_session: T::Boolean,
+            is_restricted: T::Boolean,
+            name: String,
+            supports_volume: T::Boolean,
+            type: String,
+            volume_percent: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The device ID. This ID is unique and persistent to some extent. However, this is
+          # not guaranteed and any cached `device_id` should periodically be cleared out and
+          # refetched as necessary.
+          id: nil,
+          # If this device is the currently active device.
+          is_active: nil,
+          # If this device is currently in a private session.
+          is_private_session: nil,
+          # Whether controlling this device is restricted. At present if this is "true" then
+          # no Web API commands will be accepted by this device.
+          is_restricted: nil,
+          # A human-readable name for the device. Some devices have a name that the user can
+          # configure (e.g. \"Loudest speaker\") and some devices have a generic name
+          # associated with the manufacturer or device model.
+          name: nil,
+          # If this device can be used to set the volume.
+          supports_volume: nil,
+          # Device type, such as "computer", "smartphone" or "speaker".
+          type: nil,
+          # The current volume in percent.
+          volume_percent: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: T.nilable(String),
+              is_active: T::Boolean,
+              is_private_session: T::Boolean,
+              is_restricted: T::Boolean,
+              name: String,
+              supports_volume: T::Boolean,
+              type: String,
+              volume_percent: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/me/episode_check_params.rbi

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

data/rbi/spotted/models/me/episode_check_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Me
+      EpisodeCheckResponse =
+        T.let(
+          Spotted::Internal::Type::ArrayOf[Spotted::Internal::Type::Boolean],
+          Spotted::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/spotted/models/me/episode_list_params.rbi

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

data/rbi/spotted/models/me/episode_list_response.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Me
+      class EpisodeListResponse < Spotted::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Models::Me::EpisodeListResponse,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # The date and time the episode was saved. Timestamps are returned in ISO 8601
+        # format as Coordinated Universal Time (UTC) with a zero offset:
+        # YYYY-MM-DDTHH:MM:SSZ.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :added_at
+
+        sig { params(added_at: Time).void }
+        attr_writer :added_at
+
+        # Information about the episode.
+        sig { returns(T.nilable(Spotted::EpisodeObject)) }
+        attr_reader :episode
+
+        sig { params(episode: Spotted::EpisodeObject::OrHash).void }
+        attr_writer :episode
+
+        sig do
+          params(
+            added_at: Time,
+            episode: Spotted::EpisodeObject::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The date and time the episode was saved. Timestamps are returned in ISO 8601
+          # format as Coordinated Universal Time (UTC) with a zero offset:
+          # YYYY-MM-DDTHH:MM:SSZ.
+          added_at: nil,
+          # Information about the episode.
+          episode: nil
+        )
+        end
+
+        sig do
+          override.returns({ added_at: Time, episode: Spotted::EpisodeObject })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/me/episode_remove_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Me
+      class EpisodeRemoveParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Spotted::Me::EpisodeRemoveParams, Spotted::Internal::AnyHash)
+          end
+
+        # A JSON array of the
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum
+        # of 50 items can be specified in one request. _**Note**: if the `ids` parameter
+        # is present in the query string, any IDs listed here in the body will be
+        # ignored._
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :body_ids
+
+        sig { params(body_ids: T::Array[String]).void }
+        attr_writer :body_ids
+
+        sig do
+          params(
+            body_ids: T::Array[String],
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON array of the
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum
+          # of 50 items can be specified in one request. _**Note**: if the `ids` parameter
+          # is present in the query string, any IDs listed here in the body will be
+          # ignored._
+          body_ids: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              body_ids: T::Array[String],
+              request_options: Spotted::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/me/episode_save_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Me
+      class EpisodeSaveParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Spotted::Me::EpisodeSaveParams, Spotted::Internal::AnyHash)
+          end
+
+        # A JSON array of the
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum
+        # of 50 items can be specified in one request. _**Note**: if the `ids` parameter
+        # is present in the query string, any IDs listed here in the body will be
+        # ignored._
+        sig { returns(T::Array[String]) }
+        attr_accessor :body_ids
+
+        sig do
+          params(
+            body_ids: T::Array[String],
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON array of the
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum
+          # of 50 items can be specified in one request. _**Note**: if the `ids` parameter
+          # is present in the query string, any IDs listed here in the body will be
+          # ignored._
+          body_ids:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              body_ids: T::Array[String],
+              request_options: Spotted::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/me/following_check_params.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Me
+      class FollowingCheckParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Spotted::Me::FollowingCheckParams, Spotted::Internal::AnyHash)
+          end
+
+        # A comma-separated list of the artist or the user
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) to check. For
+        # example: `ids=74ASZWbe4lXaubB36ztrGX,08td7MxkoHQkXnWAYD8d6Q`. A maximum of 50
+        # IDs can be sent in one request.
+        sig { returns(String) }
+        attr_accessor :ids
+
+        # The ID type: either `artist` or `user`.
+        sig { returns(Spotted::Me::FollowingCheckParams::Type::OrSymbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            ids: String,
+            type: Spotted::Me::FollowingCheckParams::Type::OrSymbol,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A comma-separated list of the artist or the user
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) to check. For
+          # example: `ids=74ASZWbe4lXaubB36ztrGX,08td7MxkoHQkXnWAYD8d6Q`. A maximum of 50
+          # IDs can be sent in one request.
+          ids:,
+          # The ID type: either `artist` or `user`.
+          type:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              ids: String,
+              type: Spotted::Me::FollowingCheckParams::Type::OrSymbol,
+              request_options: Spotted::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The ID type: either `artist` or `user`.
+        module Type
+          extend Spotted::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Spotted::Me::FollowingCheckParams::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ARTIST =
+            T.let(
+              :artist,
+              Spotted::Me::FollowingCheckParams::Type::TaggedSymbol
+            )
+          USER =
+            T.let(:user, Spotted::Me::FollowingCheckParams::Type::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Spotted::Me::FollowingCheckParams::Type::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/me/following_check_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Me
+      FollowingCheckResponse =
+        T.let(
+          Spotted::Internal::Type::ArrayOf[Spotted::Internal::Type::Boolean],
+          Spotted::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/spotted/models/me/following_follow_params.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Me
+      class FollowingFollowParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Me::FollowingFollowParams,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # A JSON array of the artist or user
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+        # `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`. A maximum of 50
+        # IDs can be sent in one request. _**Note**: if the `ids` parameter is present in
+        # the query string, any IDs listed here in the body will be ignored._
+        sig { returns(T::Array[String]) }
+        attr_accessor :body_ids
+
+        # The ID type.
+        sig { returns(Spotted::Me::FollowingFollowParams::Type::OrSymbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            body_ids: T::Array[String],
+            type: Spotted::Me::FollowingFollowParams::Type::OrSymbol,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A JSON array of the artist or user
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+          # `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`. A maximum of 50
+          # IDs can be sent in one request. _**Note**: if the `ids` parameter is present in
+          # the query string, any IDs listed here in the body will be ignored._
+          body_ids:,
+          # The ID type.
+          type:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              body_ids: T::Array[String],
+              type: Spotted::Me::FollowingFollowParams::Type::OrSymbol,
+              request_options: Spotted::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The ID type.
+        module Type
+          extend Spotted::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Spotted::Me::FollowingFollowParams::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ARTIST =
+            T.let(
+              :artist,
+              Spotted::Me::FollowingFollowParams::Type::TaggedSymbol
+            )
+          USER =
+            T.let(:user, Spotted::Me::FollowingFollowParams::Type::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Spotted::Me::FollowingFollowParams::Type::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end