spotted 0.1.0

data/lib/spotted/resources/browse.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Browse
+      # @return [Spotted::Resources::Browse::Categories]
+      attr_reader :categories
+
+      # @deprecated
+      #
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::BrowseGetFeaturedPlaylistsParams} for more details.
+      #
+      # Get a list of Spotify featured playlists (shown, for example, on a Spotify
+      # player's 'Browse' tab).
+      #
+      # @overload get_featured_playlists(limit: nil, locale: nil, offset: nil, request_options: {})
+      #
+      # @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+      #
+      # @param locale [String] The desired language, consisting of an [ISO 639-1](http://en.wikipedia.org/wiki/
+      #
+      # @param offset [Integer] The index of the first item to return. Default: 0 (the first item). Use with lim
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::BrowseGetFeaturedPlaylistsResponse]
+      #
+      # @see Spotted::Models::BrowseGetFeaturedPlaylistsParams
+      def get_featured_playlists(params = {})
+        parsed, options = Spotted::BrowseGetFeaturedPlaylistsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "browse/featured-playlists",
+          query: parsed,
+          model: Spotted::Models::BrowseGetFeaturedPlaylistsResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::BrowseGetNewReleasesParams} for more details.
+      #
+      # Get a list of new album releases featured in Spotify (shown, for example, on a
+      # Spotify player’s “Browse” tab).
+      #
+      # @overload get_new_releases(limit: nil, offset: nil, request_options: {})
+      #
+      # @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+      #
+      # @param offset [Integer] The index of the first item to return. Default: 0 (the first item). Use with lim
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::BrowseGetNewReleasesResponse]
+      #
+      # @see Spotted::Models::BrowseGetNewReleasesParams
+      def get_new_releases(params = {})
+        parsed, options = Spotted::BrowseGetNewReleasesParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "browse/new-releases",
+          query: parsed,
+          model: Spotted::Models::BrowseGetNewReleasesResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+        @categories = Spotted::Resources::Browse::Categories.new(client: client)
+      end
+    end
+  end
+end

data/lib/spotted/resources/chapters.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Chapters
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::ChapterRetrieveParams} for more details.
+      #
+      # Get Spotify catalog information for a single audiobook chapter. Chapters are
+      # only available within the US, UK, Canada, Ireland, New Zealand and Australia
+      # markets.
+      #
+      # @overload retrieve(id, market: nil, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
+      #
+      # @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::ChapterRetrieveResponse]
+      #
+      # @see Spotted::Models::ChapterRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Spotted::ChapterRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["chapters/%1$s", id],
+          query: parsed,
+          model: Spotted::Models::ChapterRetrieveResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::ChapterListParams} for more details.
+      #
+      # 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.
+      #
+      # @overload list(ids:, market: nil, request_options: {})
+      #
+      # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
+      #
+      # @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::ChapterListResponse]
+      #
+      # @see Spotted::Models::ChapterListParams
+      def list(params)
+        parsed, options = Spotted::ChapterListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "chapters",
+          query: parsed,
+          model: Spotted::Models::ChapterListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/spotted/resources/episodes.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Episodes
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::EpisodeRetrieveParams} for more details.
+      #
+      # Get Spotify catalog information for a single episode identified by its unique
+      # Spotify ID.
+      #
+      # @overload retrieve(id, market: nil, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the episo
+      #
+      # @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::EpisodeObject]
+      #
+      # @see Spotted::Models::EpisodeRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Spotted::EpisodeRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["episodes/%1$s", id],
+          query: parsed,
+          model: Spotted::EpisodeObject,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::EpisodeListParams} for more details.
+      #
+      # Get Spotify catalog information for several episodes based on their Spotify IDs.
+      #
+      # @overload list(ids:, market: nil, request_options: {})
+      #
+      # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
+      #
+      # @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::EpisodeListResponse]
+      #
+      # @see Spotted::Models::EpisodeListParams
+      def list(params)
+        parsed, options = Spotted::EpisodeListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "episodes",
+          query: parsed,
+          model: Spotted::Models::EpisodeListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/spotted/resources/markets.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Markets
+      # Get the list of markets where Spotify is available.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::MarketListResponse]
+      #
+      # @see Spotted::Models::MarketListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "markets",
+          model: Spotted::Models::MarketListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/spotted/resources/me/albums.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Me
+      class Albums
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::AlbumListParams} for more details.
+        #
+        # Get a list of the albums saved in the current Spotify user's 'Your Music'
+        # library.
+        #
+        # @overload list(limit: nil, market: nil, offset: nil, request_options: {})
+        #
+        # @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        #
+        # @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
+        #
+        # @param offset [Integer] The index of the first item to return. Default: 0 (the first item). Use with lim
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Spotted::Internal::CursorURLPage<Spotted::Models::Me::AlbumListResponse>]
+        #
+        # @see Spotted::Models::Me::AlbumListParams
+        def list(params = {})
+          parsed, options = Spotted::Me::AlbumListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/albums",
+            query: parsed,
+            page: Spotted::Internal::CursorURLPage,
+            model: Spotted::Models::Me::AlbumListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::AlbumCheckParams} for more details.
+        #
+        # Check if one or more albums is already saved in the current Spotify user's 'Your
+        # Music' library.
+        #
+        # @overload check(ids:, request_options: {})
+        #
+        # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Boolean>]
+        #
+        # @see Spotted::Models::Me::AlbumCheckParams
+        def check(params)
+          parsed, options = Spotted::Me::AlbumCheckParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/albums/contains",
+            query: parsed,
+            model: Spotted::Internal::Type::ArrayOf[Spotted::Internal::Type::Boolean],
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::AlbumRemoveParams} for more details.
+        #
+        # Remove one or more albums from the current user's 'Your Music' library.
+        #
+        # @overload remove(body_ids: nil, request_options: {})
+        #
+        # @param body_ids [Array<String>] Body param: A JSON array of the [Spotify IDs](/documentation/web-api/concepts/sp
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Me::AlbumRemoveParams
+        def remove(params = {})
+          parsed, options = Spotted::Me::AlbumRemoveParams.dump_request(params)
+          query_params = [:query_ids]
+          @client.request(
+            method: :delete,
+            path: "me/albums",
+            query: parsed.slice(*query_params).transform_keys(query_ids: "ids"),
+            body: parsed.except(*query_params),
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::AlbumSaveParams} for more details.
+        #
+        # Save one or more albums to the current user's 'Your Music' library.
+        #
+        # @overload save(body_ids: nil, request_options: {})
+        #
+        # @param body_ids [Array<String>] Body param: A JSON array of the [Spotify IDs](/documentation/web-api/concepts/sp
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Me::AlbumSaveParams
+        def save(params = {})
+          parsed, options = Spotted::Me::AlbumSaveParams.dump_request(params)
+          query_params = [:query_ids]
+          @client.request(
+            method: :put,
+            path: "me/albums",
+            query: parsed.slice(*query_params).transform_keys(query_ids: "ids"),
+            body: parsed.except(*query_params),
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Spotted::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/spotted/resources/me/audiobooks.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Me
+      class Audiobooks
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::AudiobookListParams} for more details.
+        #
+        # Get a list of the audiobooks saved in the current Spotify user's 'Your Music'
+        # library.
+        #
+        # @overload list(limit: nil, offset: nil, request_options: {})
+        #
+        # @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        #
+        # @param offset [Integer] The index of the first item to return. Default: 0 (the first item). Use with lim
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Spotted::Internal::CursorURLPage<Spotted::Models::Me::AudiobookListResponse>]
+        #
+        # @see Spotted::Models::Me::AudiobookListParams
+        def list(params = {})
+          parsed, options = Spotted::Me::AudiobookListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/audiobooks",
+            query: parsed,
+            page: Spotted::Internal::CursorURLPage,
+            model: Spotted::Models::Me::AudiobookListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::AudiobookCheckParams} for more details.
+        #
+        # Check if one or more audiobooks are already saved in the current Spotify user's
+        # library.
+        #
+        # @overload check(ids:, request_options: {})
+        #
+        # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Boolean>]
+        #
+        # @see Spotted::Models::Me::AudiobookCheckParams
+        def check(params)
+          parsed, options = Spotted::Me::AudiobookCheckParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/audiobooks/contains",
+            query: parsed,
+            model: Spotted::Internal::Type::ArrayOf[Spotted::Internal::Type::Boolean],
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::AudiobookRemoveParams} for more details.
+        #
+        # Remove one or more audiobooks from the Spotify user's library.
+        #
+        # @overload remove(ids:, request_options: {})
+        #
+        # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Me::AudiobookRemoveParams
+        def remove(params)
+          parsed, options = Spotted::Me::AudiobookRemoveParams.dump_request(params)
+          @client.request(
+            method: :delete,
+            path: "me/audiobooks",
+            query: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::AudiobookSaveParams} for more details.
+        #
+        # Save one or more audiobooks to the current Spotify user's library.
+        #
+        # @overload save(ids:, request_options: {})
+        #
+        # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Me::AudiobookSaveParams
+        def save(params)
+          parsed, options = Spotted::Me::AudiobookSaveParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: "me/audiobooks",
+            query: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Spotted::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/spotted/resources/me/episodes.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Me
+      class Episodes
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::EpisodeListParams} for more details.
+        #
+        # 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).
+        #
+        # @overload list(limit: nil, market: nil, offset: nil, request_options: {})
+        #
+        # @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        #
+        # @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
+        #
+        # @param offset [Integer] The index of the first item to return. Default: 0 (the first item). Use with lim
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Spotted::Internal::CursorURLPage<Spotted::Models::Me::EpisodeListResponse>]
+        #
+        # @see Spotted::Models::Me::EpisodeListParams
+        def list(params = {})
+          parsed, options = Spotted::Me::EpisodeListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/episodes",
+            query: parsed,
+            page: Spotted::Internal::CursorURLPage,
+            model: Spotted::Models::Me::EpisodeListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::EpisodeCheckParams} for more details.
+        #
+        # 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)..
+        #
+        # @overload check(ids:, request_options: {})
+        #
+        # @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Boolean>]
+        #
+        # @see Spotted::Models::Me::EpisodeCheckParams
+        def check(params)
+          parsed, options = Spotted::Me::EpisodeCheckParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/episodes/contains",
+            query: parsed,
+            model: Spotted::Internal::Type::ArrayOf[Spotted::Internal::Type::Boolean],
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::EpisodeRemoveParams} for more details.
+        #
+        # 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).
+        #
+        # @overload remove(body_ids: nil, request_options: {})
+        #
+        # @param body_ids [Array<String>] Body param: A JSON array of the [Spotify IDs](/documentation/web-api/concepts/sp
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Me::EpisodeRemoveParams
+        def remove(params = {})
+          parsed, options = Spotted::Me::EpisodeRemoveParams.dump_request(params)
+          query_params = [:query_ids]
+          @client.request(
+            method: :delete,
+            path: "me/episodes",
+            query: parsed.slice(*query_params).transform_keys(query_ids: "ids"),
+            body: parsed.except(*query_params),
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::EpisodeSaveParams} for more details.
+        #
+        # 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).
+        #
+        # @overload save(body_ids:, request_options: {})
+        #
+        # @param body_ids [Array<String>] Body param: A JSON array of the [Spotify IDs](/documentation/web-api/concepts/sp
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Me::EpisodeSaveParams
+        def save(params)
+          parsed, options = Spotted::Me::EpisodeSaveParams.dump_request(params)
+          query_params = [:query_ids]
+          @client.request(
+            method: :put,
+            path: "me/episodes",
+            query: parsed.slice(*query_params).transform_keys(query_ids: "ids"),
+            body: parsed.except(*query_params),
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Spotted::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end