spotted 0.1.0

data/lib/spotted/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Internal
+    extend Spotted::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Spotted::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Spotted::FilePart) }
+    end
+  end
+end

data/lib/spotted/models/album_list_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Albums#list
+    class AlbumListParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!attribute ids
+      #   A comma-separated list of the
+      #   [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the albums.
+      #   Maximum: 20 IDs.
+      #
+      #   @return [String]
+      required :ids, String
+
+      # @!attribute market
+      #   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/).
+      #
+      #   @return [String, nil]
+      optional :market, String
+
+      # @!method initialize(ids:, market: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::AlbumListParams} for more details.
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/spotted/models/album_list_response.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Albums#list
+    class AlbumListResponse < Spotted::Internal::Type::BaseModel
+      # @!attribute albums
+      #
+      #   @return [Array<Spotted::Models::AlbumListResponse::Album>]
+      required :albums, -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::AlbumListResponse::Album] }
+
+      # @!method initialize(albums:)
+      #   @param albums [Array<Spotted::Models::AlbumListResponse::Album>]
+
+      class Album < Spotted::Internal::Type::BaseModel
+        # @!attribute id
+        #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        #   album.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute album_type
+        #   The type of the album.
+        #
+        #   @return [Symbol, Spotted::Models::AlbumListResponse::Album::AlbumType]
+        required :album_type, enum: -> { Spotted::Models::AlbumListResponse::Album::AlbumType }
+
+        # @!attribute available_markets
+        #   The markets in which the album is available:
+        #   [ISO 3166-1 alpha-2 country codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+        #   _**NOTE**: an album is considered available in a market when at least 1 of its
+        #   tracks is available in that market._
+        #
+        #   @return [Array<String>]
+        required :available_markets, Spotted::Internal::Type::ArrayOf[String]
+
+        # @!attribute external_urls
+        #   Known external URLs for this album.
+        #
+        #   @return [Spotted::Models::ExternalURLObject]
+        required :external_urls, -> { Spotted::ExternalURLObject }
+
+        # @!attribute href
+        #   A link to the Web API endpoint providing full details of the album.
+        #
+        #   @return [String]
+        required :href, String
+
+        # @!attribute images
+        #   The cover art for the album in various sizes, widest first.
+        #
+        #   @return [Array<Spotted::Models::ImageObject>]
+        required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+        # @!attribute name
+        #   The name of the album. In case of an album takedown, the value may be an empty
+        #   string.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute release_date
+        #   The date the album was first released.
+        #
+        #   @return [String]
+        required :release_date, String
+
+        # @!attribute release_date_precision
+        #   The precision with which `release_date` value is known.
+        #
+        #   @return [Symbol, Spotted::Models::AlbumListResponse::Album::ReleaseDatePrecision]
+        required :release_date_precision,
+                 enum: -> { Spotted::Models::AlbumListResponse::Album::ReleaseDatePrecision }
+
+        # @!attribute total_tracks
+        #   The number of tracks in the album.
+        #
+        #   @return [Integer]
+        required :total_tracks, Integer
+
+        # @!attribute type
+        #   The object type.
+        #
+        #   @return [Symbol, Spotted::Models::AlbumListResponse::Album::Type]
+        required :type, enum: -> { Spotted::Models::AlbumListResponse::Album::Type }
+
+        # @!attribute uri
+        #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        #   album.
+        #
+        #   @return [String]
+        required :uri, String
+
+        # @!attribute artists
+        #   The artists of the album. Each artist object includes a link in `href` to more
+        #   detailed information about the artist.
+        #
+        #   @return [Array<Spotted::Models::SimplifiedArtistObject>, nil]
+        optional :artists, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedArtistObject] }
+
+        # @!attribute copyrights
+        #   The copyright statements of the album.
+        #
+        #   @return [Array<Spotted::Models::CopyrightObject>, nil]
+        optional :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
+
+        # @!attribute external_ids
+        #   Known external IDs for the album.
+        #
+        #   @return [Spotted::Models::ExternalIDObject, nil]
+        optional :external_ids, -> { Spotted::ExternalIDObject }
+
+        # @!attribute genres
+        #   @deprecated
+        #
+        #   **Deprecated** The array is always empty.
+        #
+        #   @return [Array<String>, nil]
+        optional :genres, Spotted::Internal::Type::ArrayOf[String]
+
+        # @!attribute label
+        #   The label associated with the album.
+        #
+        #   @return [String, nil]
+        optional :label, String
+
+        # @!attribute popularity
+        #   The popularity of the album. The value will be between 0 and 100, with 100 being
+        #   the most popular.
+        #
+        #   @return [Integer, nil]
+        optional :popularity, Integer
+
+        # @!attribute restrictions
+        #   Included in the response when a content restriction is applied.
+        #
+        #   @return [Spotted::Models::AlbumRestrictionObject, nil]
+        optional :restrictions, -> { Spotted::AlbumRestrictionObject }
+
+        # @!attribute tracks
+        #   The tracks of the album.
+        #
+        #   @return [Spotted::Models::AlbumListResponse::Album::Tracks, nil]
+        optional :tracks, -> { Spotted::Models::AlbumListResponse::Album::Tracks }
+
+        # @!method initialize(id:, album_type:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, type:, uri:, artists: nil, copyrights: nil, external_ids: nil, genres: nil, label: nil, popularity: nil, restrictions: nil, tracks: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::AlbumListResponse::Album} for more details.
+        #
+        #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the album
+        #
+        #   @param album_type [Symbol, Spotted::Models::AlbumListResponse::Album::AlbumType] The type of the album.
+        #
+        #   @param available_markets [Array<String>] The markets in which the album is available: [ISO 3166-1 alpha-2 country codes](
+        #
+        #   @param external_urls [Spotted::Models::ExternalURLObject] Known external URLs for this album.
+        #
+        #   @param href [String] A link to the Web API endpoint providing full details of the album.
+        #
+        #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the album in various sizes, widest first.
+        #
+        #   @param name [String] The name of the album. In case of an album takedown, the value may be an empty s
+        #
+        #   @param release_date [String] The date the album was first released.
+        #
+        #   @param release_date_precision [Symbol, Spotted::Models::AlbumListResponse::Album::ReleaseDatePrecision] The precision with which `release_date` value is known.
+        #
+        #   @param total_tracks [Integer] The number of tracks in the album.
+        #
+        #   @param type [Symbol, Spotted::Models::AlbumListResponse::Album::Type] The object type.
+        #
+        #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the albu
+        #
+        #   @param artists [Array<Spotted::Models::SimplifiedArtistObject>] The artists of the album. Each artist object includes a link in `href` to more d
+        #
+        #   @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the album.
+        #
+        #   @param external_ids [Spotted::Models::ExternalIDObject] Known external IDs for the album.
+        #
+        #   @param genres [Array<String>] **Deprecated** The array is always empty.
+        #
+        #   @param label [String] The label associated with the album.
+        #
+        #   @param popularity [Integer] The popularity of the album. The value will be between 0 and 100, with 100 being
+        #
+        #   @param restrictions [Spotted::Models::AlbumRestrictionObject] Included in the response when a content restriction is applied.
+        #
+        #   @param tracks [Spotted::Models::AlbumListResponse::Album::Tracks] The tracks of the album.
+
+        # The type of the album.
+        #
+        # @see Spotted::Models::AlbumListResponse::Album#album_type
+        module AlbumType
+          extend Spotted::Internal::Type::Enum
+
+          ALBUM = :album
+          SINGLE = :single
+          COMPILATION = :compilation
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The precision with which `release_date` value is known.
+        #
+        # @see Spotted::Models::AlbumListResponse::Album#release_date_precision
+        module ReleaseDatePrecision
+          extend Spotted::Internal::Type::Enum
+
+          YEAR = :year
+          MONTH = :month
+          DAY = :day
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The object type.
+        #
+        # @see Spotted::Models::AlbumListResponse::Album#type
+        module Type
+          extend Spotted::Internal::Type::Enum
+
+          ALBUM = :album
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Spotted::Models::AlbumListResponse::Album#tracks
+        class Tracks < Spotted::Internal::Type::BaseModel
+          # @!attribute href
+          #   A link to the Web API endpoint returning the full result of the request
+          #
+          #   @return [String]
+          required :href, String
+
+          # @!attribute items
+          #
+          #   @return [Array<Spotted::Models::SimplifiedTrackObject>]
+          required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedTrackObject] }
+
+          # @!attribute limit
+          #   The maximum number of items in the response (as set in the query or by default).
+          #
+          #   @return [Integer]
+          required :limit, Integer
+
+          # @!attribute next_
+          #   URL to the next page of items. ( `null` if none)
+          #
+          #   @return [String, nil]
+          required :next_, String, api_name: :next, nil?: true
+
+          # @!attribute offset
+          #   The offset of the items returned (as set in the query or by default)
+          #
+          #   @return [Integer]
+          required :offset, Integer
+
+          # @!attribute previous
+          #   URL to the previous page of items. ( `null` if none)
+          #
+          #   @return [String, nil]
+          required :previous, String, nil?: true
+
+          # @!attribute total
+          #   The total number of items available to return.
+          #
+          #   @return [Integer]
+          required :total, Integer
+
+          # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
+          #   Some parameter documentations has been truncated, see
+          #   {Spotted::Models::AlbumListResponse::Album::Tracks} for more details.
+          #
+          #   The tracks of the album.
+          #
+          #   @param href [String] A link to the Web API endpoint returning the full result of the request
+          #
+          #   @param items [Array<Spotted::Models::SimplifiedTrackObject>]
+          #
+          #   @param limit [Integer] The maximum number of items in the response (as set in the query or by default).
+          #
+          #   @param next_ [String, nil] URL to the next page of items. ( `null` if none)
+          #
+          #   @param offset [Integer] The offset of the items returned (as set in the query or by default)
+          #
+          #   @param previous [String, nil] URL to the previous page of items. ( `null` if none)
+          #
+          #   @param total [Integer] The total number of items available to return.
+        end
+      end
+    end
+  end
+end

data/lib/spotted/models/album_list_tracks_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Albums#list_tracks
+    class AlbumListTracksParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!attribute limit
+      #   The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute market
+      #   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/).
+      #
+      #   @return [String, nil]
+      optional :market, String
+
+      # @!attribute offset
+      #   The index of the first item to return. Default: 0 (the first item). Use with
+      #   limit to get the next set of items.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!method initialize(limit: nil, market: nil, offset: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::AlbumListTracksParams} for more details.
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/spotted/models/album_restriction_object.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class AlbumRestrictionObject < Spotted::Internal::Type::BaseModel
+      # @!attribute reason
+      #   The reason for the restriction. Albums may be restricted if the content is not
+      #   available in a given market, to the user's subscription type, or when the user's
+      #   account is set to not play explicit content. Additional reasons may be added in
+      #   the future.
+      #
+      #   @return [Symbol, Spotted::Models::AlbumRestrictionObject::Reason, nil]
+      optional :reason, enum: -> { Spotted::AlbumRestrictionObject::Reason }
+
+      # @!method initialize(reason: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::AlbumRestrictionObject} for more details.
+      #
+      #   @param reason [Symbol, Spotted::Models::AlbumRestrictionObject::Reason] The reason for the restriction. Albums may be restricted if the content is not a
+
+      # The reason for the restriction. Albums may be restricted if the content is not
+      # available in a given market, to the user's subscription type, or when the user's
+      # account is set to not play explicit content. Additional reasons may be added in
+      # the future.
+      #
+      # @see Spotted::Models::AlbumRestrictionObject#reason
+      module Reason
+        extend Spotted::Internal::Type::Enum
+
+        MARKET = :market
+        PRODUCT = :product
+        EXPLICIT = :explicit
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/spotted/models/album_retrieve_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Albums#retrieve
+    class AlbumRetrieveParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!attribute market
+      #   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/).
+      #
+      #   @return [String, nil]
+      optional :market, String
+
+      # @!method initialize(market: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::AlbumRetrieveParams} for more details.
+      #
+      #   @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}]
+    end
+  end
+end