spotted 0.1.0

data/lib/spotted/models/episode_object.rb

@@ -0,0 +1,382 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class EpisodeObject < Spotted::Internal::Type::BaseModel
+      # @!attribute id
+      #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   episode.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute audio_preview_url
+      #   @deprecated
+      #
+      #   A URL to a 30 second preview (MP3 format) of the episode. `null` if not
+      #   available.
+      #
+      #   @return [String, nil]
+      required :audio_preview_url, String, nil?: true
+
+      # @!attribute description
+      #   A description of the episode. HTML tags are stripped away from this field, use
+      #   `html_description` field in case HTML tags are needed.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute duration_ms
+      #   The episode length in milliseconds.
+      #
+      #   @return [Integer]
+      required :duration_ms, Integer
+
+      # @!attribute explicit
+      #   Whether or not the episode has explicit content (true = yes it does; false = no
+      #   it does not OR unknown).
+      #
+      #   @return [Boolean]
+      required :explicit, Spotted::Internal::Type::Boolean
+
+      # @!attribute external_urls
+      #   External URLs for this episode.
+      #
+      #   @return [Spotted::Models::ExternalURLObject]
+      required :external_urls, -> { Spotted::ExternalURLObject }
+
+      # @!attribute href
+      #   A link to the Web API endpoint providing full details of the episode.
+      #
+      #   @return [String]
+      required :href, String
+
+      # @!attribute html_description
+      #   A description of the episode. This field may contain HTML tags.
+      #
+      #   @return [String]
+      required :html_description, String
+
+      # @!attribute images
+      #   The cover art for the episode in various sizes, widest first.
+      #
+      #   @return [Array<Spotted::Models::ImageObject>]
+      required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+      # @!attribute is_externally_hosted
+      #   True if the episode is hosted outside of Spotify's CDN.
+      #
+      #   @return [Boolean]
+      required :is_externally_hosted, Spotted::Internal::Type::Boolean
+
+      # @!attribute is_playable
+      #   True if the episode is playable in the given market. Otherwise false.
+      #
+      #   @return [Boolean]
+      required :is_playable, Spotted::Internal::Type::Boolean
+
+      # @!attribute languages
+      #   A list of the languages used in the episode, identified by their
+      #   [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code.
+      #
+      #   @return [Array<String>]
+      required :languages, Spotted::Internal::Type::ArrayOf[String]
+
+      # @!attribute name
+      #   The name of the episode.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute release_date
+      #   The date the episode was first released, for example `"1981-12-15"`. Depending
+      #   on the precision, it might be shown as `"1981"` or `"1981-12"`.
+      #
+      #   @return [String]
+      required :release_date, String
+
+      # @!attribute release_date_precision
+      #   The precision with which `release_date` value is known.
+      #
+      #   @return [Symbol, Spotted::Models::EpisodeObject::ReleaseDatePrecision]
+      required :release_date_precision, enum: -> { Spotted::EpisodeObject::ReleaseDatePrecision }
+
+      # @!attribute show
+      #   The show on which the episode belongs.
+      #
+      #   @return [Spotted::Models::EpisodeObject::Show]
+      required :show, -> { Spotted::EpisodeObject::Show }
+
+      # @!attribute type
+      #   The object type.
+      #
+      #   @return [Symbol, Spotted::Models::EpisodeObject::Type]
+      required :type, enum: -> { Spotted::EpisodeObject::Type }
+
+      # @!attribute uri
+      #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   episode.
+      #
+      #   @return [String]
+      required :uri, String
+
+      # @!attribute language
+      #   @deprecated
+      #
+      #   The language used in the episode, identified by a
+      #   [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code. This field is deprecated
+      #   and might be removed in the future. Please use the `languages` field instead.
+      #
+      #   @return [String, nil]
+      optional :language, String
+
+      # @!attribute restrictions
+      #   Included in the response when a content restriction is applied.
+      #
+      #   @return [Spotted::Models::EpisodeRestrictionObject, nil]
+      optional :restrictions, -> { Spotted::EpisodeRestrictionObject }
+
+      # @!attribute resume_point
+      #   The user's most recent position in the episode. Set if the supplied access token
+      #   is a user token and has the scope 'user-read-playback-position'.
+      #
+      #   @return [Spotted::Models::ResumePointObject, nil]
+      optional :resume_point, -> { Spotted::ResumePointObject }
+
+      # @!method initialize(id:, audio_preview_url:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, is_playable:, languages:, name:, release_date:, release_date_precision:, show:, type:, uri:, language: nil, restrictions: nil, resume_point: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::EpisodeObject} for more details.
+      #
+      #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the episo
+      #
+      #   @param audio_preview_url [String, nil] A URL to a 30 second preview (MP3 format) of the episode. `null` if not availabl
+      #
+      #   @param description [String] A description of the episode. HTML tags are stripped away from this field, use `
+      #
+      #   @param duration_ms [Integer] The episode length in milliseconds.
+      #
+      #   @param explicit [Boolean] Whether or not the episode has explicit content (true = yes it does; false = no
+      #
+      #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this episode.
+      #
+      #   @param href [String] A link to the Web API endpoint providing full details of the episode.
+      #
+      #   @param html_description [String] A description of the episode. This field may contain HTML tags.
+      #
+      #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the episode in various sizes, widest first.
+      #
+      #   @param is_externally_hosted [Boolean] True if the episode is hosted outside of Spotify's CDN.
+      #
+      #   @param is_playable [Boolean] True if the episode is playable in the given market. Otherwise false.
+      #
+      #   @param languages [Array<String>] A list of the languages used in the episode, identified by their [ISO 639-1](htt
+      #
+      #   @param name [String] The name of the episode.
+      #
+      #   @param release_date [String] The date the episode was first released, for example `"1981-12-15"`. Depending o
+      #
+      #   @param release_date_precision [Symbol, Spotted::Models::EpisodeObject::ReleaseDatePrecision] The precision with which `release_date` value is known.
+      #
+      #   @param show [Spotted::Models::EpisodeObject::Show] The show on which the episode belongs.
+      #
+      #   @param type [Symbol, Spotted::Models::EpisodeObject::Type] The object type.
+      #
+      #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the epis
+      #
+      #   @param language [String] The language used in the episode, identified by a [ISO 639](https://en.wikipedia
+      #
+      #   @param restrictions [Spotted::Models::EpisodeRestrictionObject] Included in the response when a content restriction is applied.
+      #
+      #   @param resume_point [Spotted::Models::ResumePointObject] The user's most recent position in the episode. Set if the supplied access token
+
+      # The precision with which `release_date` value is known.
+      #
+      # @see Spotted::Models::EpisodeObject#release_date_precision
+      module ReleaseDatePrecision
+        extend Spotted::Internal::Type::Enum
+
+        YEAR = :year
+        MONTH = :month
+        DAY = :day
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Spotted::Models::EpisodeObject#show
+      class Show < Spotted::Internal::Type::BaseModel
+        # @!attribute id
+        #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute available_markets
+        #   A list of the countries in which the show can be played, identified by their
+        #   [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+        #
+        #   @return [Array<String>]
+        required :available_markets, Spotted::Internal::Type::ArrayOf[String]
+
+        # @!attribute copyrights
+        #   The copyright statements of the show.
+        #
+        #   @return [Array<Spotted::Models::CopyrightObject>]
+        required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
+
+        # @!attribute description
+        #   A description of the show. HTML tags are stripped away from this field, use
+        #   `html_description` field in case HTML tags are needed.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute explicit
+        #   Whether or not the show has explicit content (true = yes it does; false = no it
+        #   does not OR unknown).
+        #
+        #   @return [Boolean]
+        required :explicit, Spotted::Internal::Type::Boolean
+
+        # @!attribute external_urls
+        #   External URLs for this show.
+        #
+        #   @return [Spotted::Models::ExternalURLObject]
+        required :external_urls, -> { Spotted::ExternalURLObject }
+
+        # @!attribute href
+        #   A link to the Web API endpoint providing full details of the show.
+        #
+        #   @return [String]
+        required :href, String
+
+        # @!attribute html_description
+        #   A description of the show. This field may contain HTML tags.
+        #
+        #   @return [String]
+        required :html_description, String
+
+        # @!attribute images
+        #   The cover art for the show in various sizes, widest first.
+        #
+        #   @return [Array<Spotted::Models::ImageObject>]
+        required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+        # @!attribute is_externally_hosted
+        #   True if all of the shows episodes are hosted outside of Spotify's CDN. This
+        #   field might be `null` in some cases.
+        #
+        #   @return [Boolean]
+        required :is_externally_hosted, Spotted::Internal::Type::Boolean
+
+        # @!attribute languages
+        #   A list of the languages used in the show, identified by their
+        #   [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
+        #
+        #   @return [Array<String>]
+        required :languages, Spotted::Internal::Type::ArrayOf[String]
+
+        # @!attribute media_type
+        #   The media type of the show.
+        #
+        #   @return [String]
+        required :media_type, String
+
+        # @!attribute name
+        #   The name of the episode.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute publisher
+        #   The publisher of the show.
+        #
+        #   @return [String]
+        required :publisher, String
+
+        # @!attribute total_episodes
+        #   The total number of episodes in the show.
+        #
+        #   @return [Integer]
+        required :total_episodes, Integer
+
+        # @!attribute type
+        #   The object type.
+        #
+        #   @return [Symbol, Spotted::Models::EpisodeObject::Show::Type]
+        required :type, enum: -> { Spotted::EpisodeObject::Show::Type }
+
+        # @!attribute uri
+        #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        #   show.
+        #
+        #   @return [String]
+        required :uri, String
+
+        # @!method initialize(id:, available_markets:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, languages:, media_type:, name:, publisher:, total_episodes:, type:, uri:)
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::EpisodeObject::Show} for more details.
+        #
+        #   The show on which the episode belongs.
+        #
+        #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
+        #
+        #   @param available_markets [Array<String>] A list of the countries in which the show can be played, identified by their [IS
+        #
+        #   @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the show.
+        #
+        #   @param description [String] A description of the show. HTML tags are stripped away from this field, use `htm
+        #
+        #   @param explicit [Boolean] Whether or not the show has explicit content (true = yes it does; false = no it
+        #
+        #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this show.
+        #
+        #   @param href [String] A link to the Web API endpoint providing full details of the show.
+        #
+        #   @param html_description [String] A description of the show. This field may contain HTML tags.
+        #
+        #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the show in various sizes, widest first.
+        #
+        #   @param is_externally_hosted [Boolean] True if all of the shows episodes are hosted outside of Spotify's CDN. This fiel
+        #
+        #   @param languages [Array<String>] A list of the languages used in the show, identified by their [ISO 639](https://
+        #
+        #   @param media_type [String] The media type of the show.
+        #
+        #   @param name [String] The name of the episode.
+        #
+        #   @param publisher [String] The publisher of the show.
+        #
+        #   @param total_episodes [Integer] The total number of episodes in the show.
+        #
+        #   @param type [Symbol, Spotted::Models::EpisodeObject::Show::Type] The object type.
+        #
+        #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show
+
+        # The object type.
+        #
+        # @see Spotted::Models::EpisodeObject::Show#type
+        module Type
+          extend Spotted::Internal::Type::Enum
+
+          SHOW = :show
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The object type.
+      #
+      # @see Spotted::Models::EpisodeObject#type
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        EPISODE = :episode
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/spotted/models/episode_restriction_object.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class EpisodeRestrictionObject < Spotted::Internal::Type::BaseModel
+      # @!attribute reason
+      #   The reason for the restriction. Supported values:
+      #
+      #   - `market` - The content item is not available in the given market.
+      #   - `product` - The content item is not available for the user's subscription
+      #     type.
+      #   - `explicit` - The content item is explicit and the user's account is set to not
+      #     play explicit content.
+      #
+      #   Additional reasons may be added in the future. **Note**: If you use this field,
+      #   make sure that your application safely handles unknown values.
+      #
+      #   @return [String, nil]
+      optional :reason, String
+
+      # @!method initialize(reason: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::EpisodeRestrictionObject} for more details.
+      #
+      #   @param reason [String] The reason for the restriction. Supported values:
+    end
+  end
+end

data/lib/spotted/models/episode_retrieve_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Episodes#retrieve
+    class EpisodeRetrieveParams < 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::EpisodeRetrieveParams} 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

data/lib/spotted/models/external_id_object.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class ExternalIDObject < Spotted::Internal::Type::BaseModel
+      # @!attribute ean
+      #   [International Article Number](http://en.wikipedia.org/wiki/International_Article_Number_%28EAN%29)
+      #
+      #   @return [String, nil]
+      optional :ean, String
+
+      # @!attribute isrc
+      #   [International Standard Recording Code](http://en.wikipedia.org/wiki/International_Standard_Recording_Code)
+      #
+      #   @return [String, nil]
+      optional :isrc, String
+
+      # @!attribute upc
+      #   [Universal Product Code](http://en.wikipedia.org/wiki/Universal_Product_Code)
+      #
+      #   @return [String, nil]
+      optional :upc, String
+
+      # @!method initialize(ean: nil, isrc: nil, upc: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::ExternalIDObject} for more details.
+      #
+      #   @param ean [String] [International Article Number](http://en.wikipedia.org/wiki/International_Articl
+      #
+      #   @param isrc [String] [International Standard Recording Code](http://en.wikipedia.org/wiki/Internation
+      #
+      #   @param upc [String] [Universal Product Code](http://en.wikipedia.org/wiki/Universal_Product_Code)
+    end
+  end
+end

data/lib/spotted/models/external_url_object.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class ExternalURLObject < Spotted::Internal::Type::BaseModel
+      # @!attribute spotify
+      #   The [Spotify URL](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   object.
+      #
+      #   @return [String, nil]
+      optional :spotify, String
+
+      # @!method initialize(spotify: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::ExternalURLObject} for more details.
+      #
+      #   @param spotify [String] The [Spotify URL](/documentation/web-api/concepts/spotify-uris-ids) for the obje
+    end
+  end
+end

data/lib/spotted/models/followers_object.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class FollowersObject < Spotted::Internal::Type::BaseModel
+      # @!attribute href
+      #   This will always be set to null, as the Web API does not support it at the
+      #   moment.
+      #
+      #   @return [String, nil]
+      optional :href, String, nil?: true
+
+      # @!attribute total
+      #   The total number of followers.
+      #
+      #   @return [Integer, nil]
+      optional :total, Integer
+
+      # @!method initialize(href: nil, total: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::FollowersObject} for more details.
+      #
+      #   @param href [String, nil] This will always be set to null, as the Web API does not support it at the momen
+      #
+      #   @param total [Integer] The total number of followers.
+    end
+  end
+end

data/lib/spotted/models/image_object.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class ImageObject < Spotted::Internal::Type::BaseModel
+      # @!attribute height
+      #   The image height in pixels.
+      #
+      #   @return [Integer, nil]
+      required :height, Integer, nil?: true
+
+      # @!attribute url
+      #   The source URL of the image.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute width
+      #   The image width in pixels.
+      #
+      #   @return [Integer, nil]
+      required :width, Integer, nil?: true
+
+      # @!method initialize(height:, url:, width:)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::ImageObject} for more details.
+      #
+      #   @param height [Integer, nil] The image height in pixels.
+      #
+      #   @param url [String] The source URL of the image.
+      #
+      #   @param width [Integer, nil] The image width in pixels.
+    end
+  end
+end

data/lib/spotted/models/linked_track_object.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class LinkedTrackObject < Spotted::Internal::Type::BaseModel
+      # @!attribute id
+      #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   track.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute external_urls
+      #   Known external URLs for this track.
+      #
+      #   @return [Spotted::Models::ExternalURLObject, nil]
+      optional :external_urls, -> { Spotted::ExternalURLObject }
+
+      # @!attribute href
+      #   A link to the Web API endpoint providing full details of the track.
+      #
+      #   @return [String, nil]
+      optional :href, String
+
+      # @!attribute type
+      #   The object type: "track".
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!attribute uri
+      #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   track.
+      #
+      #   @return [String, nil]
+      optional :uri, String
+
+      # @!method initialize(id: nil, external_urls: nil, href: nil, type: nil, uri: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::LinkedTrackObject} for more details.
+      #
+      #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the track
+      #
+      #   @param external_urls [Spotted::Models::ExternalURLObject] Known external URLs for this track.
+      #
+      #   @param href [String] A link to the Web API endpoint providing full details of the track.
+      #
+      #   @param type [String] The object type: "track".
+      #
+      #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the trac
+    end
+  end
+end

data/lib/spotted/models/market_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Markets#list
+    class MarketListParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/spotted/models/market_list_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Markets#list
+    class MarketListResponse < Spotted::Internal::Type::BaseModel
+      # @!attribute markets
+      #
+      #   @return [Array<String>, nil]
+      optional :markets, Spotted::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(markets: nil)
+      #   @param markets [Array<String>]
+    end
+  end
+end

data/lib/spotted/models/me/album_check_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Albums#check
+      class AlbumCheckParams < 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
+
+        # @!method initialize(ids:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::AlbumCheckParams} for more details.
+        #
+        #   @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end