spotted 0.1.0

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Me
+      class Shows
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::ShowListParams} for more details.
+        #
+        # Get a list of shows saved in the current Spotify user's library. Optional
+        # parameters can be used to limit the number of shows returned.
+        #
+        # @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::ShowListResponse>]
+        #
+        # @see Spotted::Models::Me::ShowListParams
+        def list(params = {})
+          parsed, options = Spotted::Me::ShowListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/shows",
+            query: parsed,
+            page: Spotted::Internal::CursorURLPage,
+            model: Spotted::Models::Me::ShowListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::ShowCheckParams} for more details.
+        #
+        # Check if one or more shows is 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::ShowCheckParams
+        def check(params)
+          parsed, options = Spotted::Me::ShowCheckParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/shows/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::ShowRemoveParams} for more details.
+        #
+        # Delete one or more shows from current Spotify user's library.
+        #
+        # @overload remove(body_ids: nil, market: nil, request_options: {})
+        #
+        # @param body_ids [Array<String>] Body param: A JSON array of the [Spotify IDs](https://developer.spotify.com/docu
+        #
+        # @param market [String] Query param: An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Me::ShowRemoveParams
+        def remove(params = {})
+          parsed, options = Spotted::Me::ShowRemoveParams.dump_request(params)
+          query_params = [:query_ids, :market]
+          @client.request(
+            method: :delete,
+            path: "me/shows",
+            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::ShowSaveParams} for more details.
+        #
+        # Save one or more shows to current Spotify user's library.
+        #
+        # @overload save(body_ids: nil, request_options: {})
+        #
+        # @param body_ids [Array<String>] Body param: A JSON array of the [Spotify IDs](https://developer.spotify.com/docu
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Me::ShowSaveParams
+        def save(params = {})
+          parsed, options = Spotted::Me::ShowSaveParams.dump_request(params)
+          query_params = [:query_ids]
+          @client.request(
+            method: :put,
+            path: "me/shows",
+            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/top.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Me
+      class Top
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::TopListTopArtistsParams} for more details.
+        #
+        # Get the current user's top artists based on calculated affinity.
+        #
+        # @overload list_top_artists(limit: nil, offset: nil, time_range: 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 time_range [String] Over what time frame the affinities are computed. Valid values: `long_term` (cal
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Spotted::Internal::CursorURLPage<Spotted::Models::ArtistObject>]
+        #
+        # @see Spotted::Models::Me::TopListTopArtistsParams
+        def list_top_artists(params = {})
+          parsed, options = Spotted::Me::TopListTopArtistsParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/top/artists",
+            query: parsed,
+            page: Spotted::Internal::CursorURLPage,
+            model: Spotted::ArtistObject,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::TopListTopTracksParams} for more details.
+        #
+        # Get the current user's top tracks based on calculated affinity.
+        #
+        # @overload list_top_tracks(limit: nil, offset: nil, time_range: 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 time_range [String] Over what time frame the affinities are computed. Valid values: `long_term` (cal
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Spotted::Internal::CursorURLPage<Spotted::Models::TrackObject>]
+        #
+        # @see Spotted::Models::Me::TopListTopTracksParams
+        def list_top_tracks(params = {})
+          parsed, options = Spotted::Me::TopListTopTracksParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/top/tracks",
+            query: parsed,
+            page: Spotted::Internal::CursorURLPage,
+            model: Spotted::TrackObject,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Spotted::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Me
+      class Tracks
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::TrackListParams} for more details.
+        #
+        # Get a list of the songs 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::TrackListResponse>]
+        #
+        # @see Spotted::Models::Me::TrackListParams
+        def list(params = {})
+          parsed, options = Spotted::Me::TrackListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/tracks",
+            query: parsed,
+            page: Spotted::Internal::CursorURLPage,
+            model: Spotted::Models::Me::TrackListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Me::TrackCheckParams} for more details.
+        #
+        # Check if one or more tracks 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::TrackCheckParams
+        def check(params)
+          parsed, options = Spotted::Me::TrackCheckParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "me/tracks/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::TrackRemoveParams} for more details.
+        #
+        # Remove one or more tracks 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::TrackRemoveParams
+        def remove(params = {})
+          parsed, options = Spotted::Me::TrackRemoveParams.dump_request(params)
+          query_params = [:query_ids]
+          @client.request(
+            method: :delete,
+            path: "me/tracks",
+            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::TrackSaveParams} for more details.
+        #
+        # Save one or more tracks to the current user's 'Your Music' library.
+        #
+        # @overload save(ids:, timestamped_ids: nil, request_options: {})
+        #
+        # @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
+        #
+        # @param timestamped_ids [Array<Spotted::Models::Me::TrackSaveParams::TimestampedID>] A JSON array of objects containing track IDs with their corresponding timestamps
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Me::TrackSaveParams
+        def save(params)
+          parsed, options = Spotted::Me::TrackSaveParams.dump_request(params)
+          @client.request(method: :put, path: "me/tracks", body: 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.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Me
+      # @return [Spotted::Resources::Me::Audiobooks]
+      attr_reader :audiobooks
+
+      # @return [Spotted::Resources::Me::Playlists]
+      attr_reader :playlists
+
+      # @return [Spotted::Resources::Me::Top]
+      attr_reader :top
+
+      # @return [Spotted::Resources::Me::Albums]
+      attr_reader :albums
+
+      # @return [Spotted::Resources::Me::Tracks]
+      attr_reader :tracks
+
+      # @return [Spotted::Resources::Me::Episodes]
+      attr_reader :episodes
+
+      # @return [Spotted::Resources::Me::Shows]
+      attr_reader :shows
+
+      # @return [Spotted::Resources::Me::Following]
+      attr_reader :following
+
+      # @return [Spotted::Resources::Me::Player]
+      attr_reader :player
+
+      # Get detailed profile information about the current user (including the current
+      # user's username).
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::MeRetrieveResponse]
+      #
+      # @see Spotted::Models::MeRetrieveParams
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "me",
+          model: Spotted::Models::MeRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+        @audiobooks = Spotted::Resources::Me::Audiobooks.new(client: client)
+        @playlists = Spotted::Resources::Me::Playlists.new(client: client)
+        @top = Spotted::Resources::Me::Top.new(client: client)
+        @albums = Spotted::Resources::Me::Albums.new(client: client)
+        @tracks = Spotted::Resources::Me::Tracks.new(client: client)
+        @episodes = Spotted::Resources::Me::Episodes.new(client: client)
+        @shows = Spotted::Resources::Me::Shows.new(client: client)
+        @following = Spotted::Resources::Me::Following.new(client: client)
+        @player = Spotted::Resources::Me::Player.new(client: client)
+      end
+    end
+  end
+end

data/lib/spotted/resources/playlists/followers.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Playlists
+      class Followers
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Playlists::FollowerCheckParams} for more details.
+        #
+        # Check to see if the current user is following a specified playlist.
+        #
+        # @overload check(playlist_id, ids: nil, request_options: {})
+        #
+        # @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
+        #
+        # @param ids [String] **Deprecated** A single item list containing current user's [Spotify Username](/
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Boolean>]
+        #
+        # @see Spotted::Models::Playlists::FollowerCheckParams
+        def check(playlist_id, params = {})
+          parsed, options = Spotted::Playlists::FollowerCheckParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["playlists/%1$s/followers/contains", playlist_id],
+            query: parsed,
+            model: Spotted::Internal::Type::ArrayOf[Spotted::Internal::Type::Boolean],
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Playlists::FollowerFollowParams} for more details.
+        #
+        # Add the current user as a follower of a playlist.
+        #
+        # @overload follow(playlist_id, public: nil, request_options: {})
+        #
+        # @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
+        #
+        # @param public [Boolean] Defaults to `true`. If `true` the playlist will be included in user's public pla
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Playlists::FollowerFollowParams
+        def follow(playlist_id, params = {})
+          parsed, options = Spotted::Playlists::FollowerFollowParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["playlists/%1$s/followers", playlist_id],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Playlists::FollowerUnfollowParams} for more details.
+        #
+        # Remove the current user as a follower of a playlist.
+        #
+        # @overload unfollow(playlist_id, request_options: {})
+        #
+        # @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Playlists::FollowerUnfollowParams
+        def unfollow(playlist_id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["playlists/%1$s/followers", playlist_id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Spotted::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/spotted/resources/playlists/images.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Playlists
+      class Images
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Playlists::ImageUpdateParams} for more details.
+        #
+        # Replace the image used to represent a specific playlist.
+        #
+        # @overload update(playlist_id, body:, request_options: {})
+        #
+        # @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
+        #
+        # @param body [String] Base64 encoded JPEG image data, maximum payload size is 256 KB.
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Spotted::Models::Playlists::ImageUpdateParams
+        def update(playlist_id, params)
+          parsed, options = Spotted::Playlists::ImageUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["playlists/%1$s/images", playlist_id],
+            headers: {"content-type" => "image/jpeg"},
+            body: parsed[:body],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Playlists::ImageListParams} for more details.
+        #
+        # Get the current image associated with a specific playlist.
+        #
+        # @overload list(playlist_id, request_options: {})
+        #
+        # @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Spotted::Models::ImageObject>]
+        #
+        # @see Spotted::Models::Playlists::ImageListParams
+        def list(playlist_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["playlists/%1$s/images", playlist_id],
+            model: Spotted::Internal::Type::ArrayOf[Spotted::ImageObject],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Spotted::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end