spotted 0.1.0

data/lib/spotted/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Spotted
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Spotted::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Spotted::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Spotted::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Spotted::Internal::Type::HashOf[Spotted::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Spotted::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Spotted::Internal::Type::HashOf[Spotted::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Spotted::RequestOptions, Spotted::Internal::AnyHash) }
+    end
+  end
+end

data/lib/spotted/resources/albums.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Albums
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::AlbumRetrieveParams} for more details.
+      #
+      # Get Spotify catalog information for a single album.
+      #
+      # @overload retrieve(id, market: nil, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the album.
+      #
+      # @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::AlbumRetrieveResponse]
+      #
+      # @see Spotted::Models::AlbumRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Spotted::AlbumRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["albums/%1$s", id],
+          query: parsed,
+          model: Spotted::Models::AlbumRetrieveResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::AlbumListParams} for more details.
+      #
+      # Get Spotify catalog information for multiple albums identified by 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::AlbumListResponse]
+      #
+      # @see Spotted::Models::AlbumListParams
+      def list(params)
+        parsed, options = Spotted::AlbumListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "albums",
+          query: parsed,
+          model: Spotted::Models::AlbumListResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::AlbumListTracksParams} for more details.
+      #
+      # Get Spotify catalog information about an album’s tracks. Optional parameters can
+      # be used to limit the number of tracks returned.
+      #
+      # @overload list_tracks(id, limit: nil, market: nil, offset: nil, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the album.
+      #
+      # @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::SimplifiedTrackObject>]
+      #
+      # @see Spotted::Models::AlbumListTracksParams
+      def list_tracks(id, params = {})
+        parsed, options = Spotted::AlbumListTracksParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["albums/%1$s/tracks", id],
+          query: parsed,
+          page: Spotted::Internal::CursorURLPage,
+          model: Spotted::SimplifiedTrackObject,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/spotted/resources/artists.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Artists
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::ArtistRetrieveParams} for more details.
+      #
+      # Get Spotify catalog information for a single artist identified by their unique
+      # Spotify ID.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the artist
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::ArtistObject]
+      #
+      # @see Spotted::Models::ArtistRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["artists/%1$s", id],
+          model: Spotted::ArtistObject,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::ArtistListParams} for more details.
+      #
+      # Get Spotify catalog information for several artists based on their Spotify IDs.
+      #
+      # @overload list(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 [Spotted::Models::ArtistListResponse]
+      #
+      # @see Spotted::Models::ArtistListParams
+      def list(params)
+        parsed, options = Spotted::ArtistListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "artists",
+          query: parsed,
+          model: Spotted::Models::ArtistListResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::ArtistListAlbumsParams} for more details.
+      #
+      # Get Spotify catalog information about an artist's albums.
+      #
+      # @overload list_albums(id, include_groups: nil, limit: nil, market: nil, offset: nil, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the artist
+      #
+      # @param include_groups [String] A comma-separated list of keywords that will be used to filter the response. If
+      #
+      # @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::ArtistListAlbumsResponse>]
+      #
+      # @see Spotted::Models::ArtistListAlbumsParams
+      def list_albums(id, params = {})
+        parsed, options = Spotted::ArtistListAlbumsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["artists/%1$s/albums", id],
+          query: parsed,
+          page: Spotted::Internal::CursorURLPage,
+          model: Spotted::Models::ArtistListAlbumsResponse,
+          options: options
+        )
+      end
+
+      # @deprecated
+      #
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::ArtistListRelatedArtistsParams} for more details.
+      #
+      # Get Spotify catalog information about artists similar to a given artist.
+      # Similarity is based on analysis of the Spotify community's listening history.
+      #
+      # @overload list_related_artists(id, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the artist
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::ArtistListRelatedArtistsResponse]
+      #
+      # @see Spotted::Models::ArtistListRelatedArtistsParams
+      def list_related_artists(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["artists/%1$s/related-artists", id],
+          model: Spotted::Models::ArtistListRelatedArtistsResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::ArtistListTopTracksParams} for more details.
+      #
+      # Get Spotify catalog information about an artist's top tracks by country.
+      #
+      # @overload list_top_tracks(id, market: nil, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the artist
+      #
+      # @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::ArtistListTopTracksResponse]
+      #
+      # @see Spotted::Models::ArtistListTopTracksParams
+      def list_top_tracks(id, params = {})
+        parsed, options = Spotted::ArtistListTopTracksParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["artists/%1$s/top-tracks", id],
+          query: parsed,
+          model: Spotted::Models::ArtistListTopTracksResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/spotted/resources/audio_analysis.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class AudioAnalysis
+      # @deprecated
+      #
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::AudioAnalysisRetrieveParams} for more details.
+      #
+      # Get a low-level audio analysis for a track in the Spotify catalog. The audio
+      # analysis describes the track’s structure and musical content, including rhythm,
+      # pitch, and timbre.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::AudioAnalysisRetrieveResponse]
+      #
+      # @see Spotted::Models::AudioAnalysisRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["audio-analysis/%1$s", id],
+          model: Spotted::Models::AudioAnalysisRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/spotted/resources/audio_features.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class AudioFeatures
+      # @deprecated
+      #
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::AudioFeatureRetrieveParams} for more details.
+      #
+      # Get audio feature information for a single track identified by its unique
+      # Spotify ID.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the track
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::AudioFeatureRetrieveResponse]
+      #
+      # @see Spotted::Models::AudioFeatureRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["audio-features/%1$s", id],
+          model: Spotted::Models::AudioFeatureRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @deprecated
+      #
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::AudioFeatureListParams} for more details.
+      #
+      # Get audio features for multiple tracks based on their Spotify IDs.
+      #
+      # @overload list(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 [Spotted::Models::AudioFeatureListResponse]
+      #
+      # @see Spotted::Models::AudioFeatureListParams
+      def list(params)
+        parsed, options = Spotted::AudioFeatureListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "audio-features",
+          query: parsed,
+          model: Spotted::Models::AudioFeatureListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/spotted/resources/audiobooks.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Audiobooks
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::AudiobookRetrieveParams} for more details.
+      #
+      # Get Spotify catalog information for a single audiobook. Audiobooks 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::AudiobookRetrieveResponse]
+      #
+      # @see Spotted::Models::AudiobookRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Spotted::AudiobookRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["audiobooks/%1$s", id],
+          query: parsed,
+          model: Spotted::Models::AudiobookRetrieveResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::AudiobookListParams} for more details.
+      #
+      # Get Spotify catalog information for several audiobooks identified by their
+      # Spotify IDs. Audiobooks 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::AudiobookListResponse]
+      #
+      # @see Spotted::Models::AudiobookListParams
+      def list(params)
+        parsed, options = Spotted::AudiobookListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "audiobooks",
+          query: parsed,
+          model: Spotted::Models::AudiobookListResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::AudiobookListChaptersParams} for more details.
+      #
+      # Get Spotify catalog information about an audiobook's chapters. Audiobooks are
+      # only available within the US, UK, Canada, Ireland, New Zealand and Australia
+      # markets.
+      #
+      # @overload list_chapters(id, limit: nil, market: nil, offset: nil, request_options: {})
+      #
+      # @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
+      #
+      # @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::SimplifiedChapterObject>]
+      #
+      # @see Spotted::Models::AudiobookListChaptersParams
+      def list_chapters(id, params = {})
+        parsed, options = Spotted::AudiobookListChaptersParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["audiobooks/%1$s/chapters", id],
+          query: parsed,
+          page: Spotted::Internal::CursorURLPage,
+          model: Spotted::SimplifiedChapterObject,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/spotted/resources/browse/categories.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Browse
+      class Categories
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Browse::CategoryRetrieveParams} for more details.
+        #
+        # Get a single category used to tag items in Spotify (on, for example, the Spotify
+        # player’s “Browse” tab).
+        #
+        # @overload retrieve(category_id, locale: nil, request_options: {})
+        #
+        # @param category_id [String] The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) for
+        #
+        # @param locale [String] The desired language, consisting of an [ISO 639-1](http://en.wikipedia.org/wiki/
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Spotted::Models::Browse::CategoryRetrieveResponse]
+        #
+        # @see Spotted::Models::Browse::CategoryRetrieveParams
+        def retrieve(category_id, params = {})
+          parsed, options = Spotted::Browse::CategoryRetrieveParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["browse/categories/%1$s", category_id],
+            query: parsed,
+            model: Spotted::Models::Browse::CategoryRetrieveResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Browse::CategoryListParams} for more details.
+        #
+        # Get a list of categories used to tag items in Spotify (on, for example, the
+        # Spotify player’s “Browse” tab).
+        #
+        # @overload list(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::Browse::CategoryListResponse]
+        #
+        # @see Spotted::Models::Browse::CategoryListParams
+        def list(params = {})
+          parsed, options = Spotted::Browse::CategoryListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "browse/categories",
+            query: parsed,
+            model: Spotted::Models::Browse::CategoryListResponse,
+            options: options
+          )
+        end
+
+        # @deprecated
+        #
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Browse::CategoryGetPlaylistsParams} for more details.
+        #
+        # Get a list of Spotify playlists tagged with a particular category.
+        #
+        # @overload get_playlists(category_id, limit: nil, offset: nil, request_options: {})
+        #
+        # @param category_id [String] The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) for
+        #
+        # @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::Browse::CategoryGetPlaylistsResponse]
+        #
+        # @see Spotted::Models::Browse::CategoryGetPlaylistsParams
+        def get_playlists(category_id, params = {})
+          parsed, options = Spotted::Browse::CategoryGetPlaylistsParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["browse/categories/%1$s/playlists", category_id],
+            query: parsed,
+            model: Spotted::Models::Browse::CategoryGetPlaylistsResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Spotted::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end