spotted 0.1.0

data/rbi/spotted/resources/browse.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Browse
+      sig { returns(Spotted::Resources::Browse::Categories) }
+      attr_reader :categories
+
+      # Get a list of Spotify featured playlists (shown, for example, on a Spotify
+      # player's 'Browse' tab).
+      sig do
+        params(
+          limit: Integer,
+          locale: String,
+          offset: Integer,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::BrowseGetFeaturedPlaylistsResponse)
+      end
+      def get_featured_playlists(
+        # 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 "Spanish
+        # (Mexico)". 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
+
+      # Get a list of new album releases featured in Spotify (shown, for example, on a
+      # Spotify player’s “Browse” tab).
+      sig do
+        params(
+          limit: Integer,
+          offset: Integer,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::BrowseGetNewReleasesResponse)
+      end
+      def get_new_releases(
+        # 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
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/spotted/resources/chapters.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Chapters
+      # Get Spotify catalog information for a single audiobook chapter. Chapters are
+      # only available within the US, UK, Canada, Ireland, New Zealand and Australia
+      # markets.
+      sig do
+        params(
+          id: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::ChapterRetrieveResponse)
+      end
+      def retrieve(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # chapter.
+        id,
+        # 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
+
+      # Get Spotify catalog information for several audiobook chapters identified by
+      # their Spotify IDs. Chapters are only available within the US, UK, Canada,
+      # Ireland, New Zealand and Australia markets.
+      sig do
+        params(
+          ids: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::ChapterListResponse)
+      end
+      def list(
+        # A comma-separated list of the
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+        # `ids=0IsXVP0JmcB2adSE338GkK,3ZXb8FKZGU0EHALYX6uCzU`. 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
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/spotted/resources/episodes.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Episodes
+      # Get Spotify catalog information for a single episode identified by its unique
+      # Spotify ID.
+      sig do
+        params(
+          id: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::EpisodeObject)
+      end
+      def retrieve(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # episode.
+        id,
+        # 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
+
+      # Get Spotify catalog information for several episodes based on their Spotify IDs.
+      sig do
+        params(
+          ids: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::EpisodeListResponse)
+      end
+      def list(
+        # A comma-separated list of the
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # episodes. 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
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/spotted/resources/markets.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Markets
+      # Get the list of markets where Spotify is available.
+      sig do
+        params(request_options: Spotted::RequestOptions::OrHash).returns(
+          Spotted::Models::MarketListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/spotted/resources/me/albums.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Me
+      class Albums
+        # Get a list of the albums saved in the current Spotify user's 'Your Music'
+        # library.
+        sig do
+          params(
+            limit: Integer,
+            market: String,
+            offset: Integer,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(
+            Spotted::Internal::CursorURLPage[
+              Spotted::Models::Me::AlbumListResponse
+            ]
+          )
+        end
+        def list(
+          # 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
+
+        # Check if one or more albums is already saved in the current Spotify user's 'Your
+        # Music' library.
+        sig do
+          params(
+            ids: String,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T::Array[T::Boolean])
+        end
+        def check(
+          # A comma-separated list of the
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the albums.
+          # Maximum: 20 IDs.
+          ids:,
+          request_options: {}
+        )
+        end
+
+        # Remove one or more albums from the current user's 'Your Music' library.
+        sig do
+          params(
+            body_ids: T::Array[String],
+            request_options: Spotted::RequestOptions::OrHash
+          ).void
+        end
+        def remove(
+          # Body param: A JSON array of the
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+          # `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<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
+
+        # Save one or more albums to the current user's 'Your Music' library.
+        sig do
+          params(
+            body_ids: T::Array[String],
+            request_options: Spotted::RequestOptions::OrHash
+          ).void
+        end
+        def save(
+          # Body param: A JSON array of the
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+          # `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<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
+
+        # @api private
+        sig { params(client: Spotted::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/resources/me/audiobooks.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Me
+      class Audiobooks
+        # Get a list of the audiobooks saved in the current Spotify user's 'Your Music'
+        # library.
+        sig do
+          params(
+            limit: Integer,
+            offset: Integer,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(
+            Spotted::Internal::CursorURLPage[
+              Spotted::Models::Me::AudiobookListResponse
+            ]
+          )
+        end
+        def list(
+          # 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
+
+        # Check if one or more audiobooks are already saved in the current Spotify user's
+        # library.
+        sig do
+          params(
+            ids: String,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T::Array[T::Boolean])
+        end
+        def check(
+          # A comma-separated list of the
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+          # `ids=18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ`. Maximum: 50 IDs.
+          ids:,
+          request_options: {}
+        )
+        end
+
+        # Remove one or more audiobooks from the Spotify user's library.
+        sig do
+          params(
+            ids: String,
+            request_options: Spotted::RequestOptions::OrHash
+          ).void
+        end
+        def remove(
+          # A comma-separated list of the
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+          # `ids=18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ`. Maximum: 50 IDs.
+          ids:,
+          request_options: {}
+        )
+        end
+
+        # Save one or more audiobooks to the current Spotify user's library.
+        sig do
+          params(
+            ids: String,
+            request_options: Spotted::RequestOptions::OrHash
+          ).void
+        end
+        def save(
+          # A comma-separated list of the
+          # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+          # `ids=18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ`. Maximum: 50 IDs.
+          ids:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Spotted::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/resources/me/episodes.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Me
+      class Episodes
+        # Get a list of the episodes saved in the current Spotify user's library.<br/>
+        # This API endpoint is in **beta** and could change without warning. Please share
+        # any feedback that you have, or issues that you discover, in our
+        # [developer community forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).
+        sig do
+          params(
+            limit: Integer,
+            market: String,
+            offset: Integer,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(
+            Spotted::Internal::CursorURLPage[
+              Spotted::Models::Me::EpisodeListResponse
+            ]
+          )
+        end
+        def list(
+          # 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
+
+        # Check if one or more episodes is already saved in the current Spotify user's
+        # 'Your Episodes' library.<br/> This API endpoint is in **beta** and could change
+        # without warning. Please share any feedback that you have, or issues that you
+        # discover, in our
+        # [developer community forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer)..
+        sig do
+          params(
+            ids: String,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T::Array[T::Boolean])
+        end
+        def check(
+          # 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
+
+        # Remove one or more episodes from the current user's library.<br/> This API
+        # endpoint is in **beta** and could change without warning. Please share any
+        # feedback that you have, or issues that you discover, in our
+        # [developer community forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).
+        sig do
+          params(
+            body_ids: T::Array[String],
+            request_options: Spotted::RequestOptions::OrHash
+          ).void
+        end
+        def remove(
+          # Body param: 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
+
+        # Save one or more episodes to the current user's library.<br/> This API endpoint
+        # is in **beta** and could change without warning. Please share any feedback that
+        # you have, or issues that you discover, in our
+        # [developer community forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).
+        sig do
+          params(
+            body_ids: T::Array[String],
+            request_options: Spotted::RequestOptions::OrHash
+          ).void
+        end
+        def save(
+          # Body param: 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
+
+        # @api private
+        sig { params(client: Spotted::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/resources/me/following.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Me
+      class Following
+        # Get the current user's followed artists.
+        sig do
+          params(
+            type: Spotted::Me::FollowingListParams::Type::OrSymbol,
+            after: String,
+            limit: Integer,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(Spotted::Models::Me::FollowingListResponse)
+        end
+        def list(
+          # The ID type: currently only `artist` is supported.
+          type:,
+          # The last artist ID retrieved from the previous request.
+          after: nil,
+          # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+          limit: nil,
+          request_options: {}
+        )
+        end
+
+        # Check to see if the current user is following one or more artists or other
+        # Spotify users.
+        sig do
+          params(
+            ids: String,
+            type: Spotted::Me::FollowingCheckParams::Type::OrSymbol,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T::Array[T::Boolean])
+        end
+        def check(
+          # 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
+
+        # Add the current user as a follower of one or more artists or other Spotify
+        # users.
+        sig do
+          params(
+            body_ids: T::Array[String],
+            type: Spotted::Me::FollowingFollowParams::Type::OrSymbol,
+            request_options: Spotted::RequestOptions::OrHash
+          ).void
+        end
+        def follow(
+          # Body param: 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:,
+          # Query param: The ID type.
+          type:,
+          request_options: {}
+        )
+        end
+
+        # Remove the current user as a follower of one or more artists or other Spotify
+        # users.
+        sig do
+          params(
+            type: Spotted::Me::FollowingUnfollowParams::Type::OrSymbol,
+            body_ids: T::Array[String],
+            request_options: Spotted::RequestOptions::OrHash
+          ).void
+        end
+        def unfollow(
+          # Query param: The ID type: either `artist` or `user`.
+          type:,
+          # Body param: 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: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Spotted::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/resources/me/player/queue.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Me
+      class Player
+        class Queue
+          # Add an item to be played next in the user's current playback queue. This API
+          # only works for users who have Spotify Premium. The order of execution is not
+          # guaranteed when you use this API with other Player API endpoints.
+          sig do
+            params(
+              uri: String,
+              device_id: String,
+              request_options: Spotted::RequestOptions::OrHash
+            ).void
+          end
+          def add(
+            # The uri of the item to add to the queue. Must be a track or an episode uri.
+            uri:,
+            # The id of the device this command is targeting. If not supplied, the user's
+            # currently active device is the target.
+            device_id: nil,
+            request_options: {}
+          )
+          end
+
+          # Get the list of objects that make up the user's queue.
+          sig do
+            params(request_options: Spotted::RequestOptions::OrHash).returns(
+              Spotted::Models::Me::Player::QueueGetResponse
+            )
+          end
+          def get(request_options: {})
+          end
+
+          # @api private
+          sig { params(client: Spotted::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end