spotted 0.1.0

data/lib/spotted/models/simplified_chapter_object.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Audiobooks#list_chapters
+    class SimplifiedChapterObject < Spotted::Internal::Type::BaseModel
+      # @!attribute id
+      #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   chapter.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute audio_preview_url
+      #   @deprecated
+      #
+      #   A URL to a 30 second preview (MP3 format) of the chapter. `null` if not
+      #   available.
+      #
+      #   @return [String, nil]
+      required :audio_preview_url, String, nil?: true
+
+      # @!attribute chapter_number
+      #   The number of the chapter
+      #
+      #   @return [Integer]
+      required :chapter_number, Integer
+
+      # @!attribute description
+      #   A description of the chapter. 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 chapter length in milliseconds.
+      #
+      #   @return [Integer]
+      required :duration_ms, Integer
+
+      # @!attribute explicit
+      #   Whether or not the chapter 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 chapter.
+      #
+      #   @return [Spotted::Models::ExternalURLObject]
+      required :external_urls, -> { Spotted::ExternalURLObject }
+
+      # @!attribute href
+      #   A link to the Web API endpoint providing full details of the chapter.
+      #
+      #   @return [String]
+      required :href, String
+
+      # @!attribute html_description
+      #   A description of the chapter. This field may contain HTML tags.
+      #
+      #   @return [String]
+      required :html_description, String
+
+      # @!attribute images
+      #   The cover art for the chapter in various sizes, widest first.
+      #
+      #   @return [Array<Spotted::Models::ImageObject>]
+      required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+      # @!attribute is_playable
+      #   True if the chapter 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 chapter, 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 chapter.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute release_date
+      #   The date the chapter 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::SimplifiedChapterObject::ReleaseDatePrecision]
+      required :release_date_precision, enum: -> { Spotted::SimplifiedChapterObject::ReleaseDatePrecision }
+
+      # @!attribute type
+      #   The object type.
+      #
+      #   @return [Symbol, Spotted::Models::SimplifiedChapterObject::Type]
+      required :type, enum: -> { Spotted::SimplifiedChapterObject::Type }
+
+      # @!attribute uri
+      #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   chapter.
+      #
+      #   @return [String]
+      required :uri, String
+
+      # @!attribute available_markets
+      #   A list of the countries in which the chapter 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>, nil]
+      optional :available_markets, Spotted::Internal::Type::ArrayOf[String]
+
+      # @!attribute restrictions
+      #   Included in the response when a content restriction is applied.
+      #
+      #   @return [Spotted::Models::ChapterRestrictionObject, nil]
+      optional :restrictions, -> { Spotted::ChapterRestrictionObject }
+
+      # @!attribute resume_point
+      #   The user's most recent position in the chapter. 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:, chapter_number:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_playable:, languages:, name:, release_date:, release_date_precision:, type:, uri:, available_markets: nil, restrictions: nil, resume_point: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::SimplifiedChapterObject} for more details.
+      #
+      #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the chapt
+      #
+      #   @param audio_preview_url [String, nil] A URL to a 30 second preview (MP3 format) of the chapter. `null` if not availabl
+      #
+      #   @param chapter_number [Integer] The number of the chapter
+      #
+      #   @param description [String] A description of the chapter. HTML tags are stripped away from this field, use `
+      #
+      #   @param duration_ms [Integer] The chapter length in milliseconds.
+      #
+      #   @param explicit [Boolean] Whether or not the chapter has explicit content (true = yes it does; false = no
+      #
+      #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this chapter.
+      #
+      #   @param href [String] A link to the Web API endpoint providing full details of the chapter.
+      #
+      #   @param html_description [String] A description of the chapter. This field may contain HTML tags.
+      #
+      #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the chapter in various sizes, widest first.
+      #
+      #   @param is_playable [Boolean] True if the chapter is playable in the given market. Otherwise false.
+      #
+      #   @param languages [Array<String>] A list of the languages used in the chapter, identified by their [ISO 639-1](htt
+      #
+      #   @param name [String] The name of the chapter.
+      #
+      #   @param release_date [String] The date the chapter was first released, for example `"1981-12-15"`. Depending o
+      #
+      #   @param release_date_precision [Symbol, Spotted::Models::SimplifiedChapterObject::ReleaseDatePrecision] The precision with which `release_date` value is known.
+      #
+      #   @param type [Symbol, Spotted::Models::SimplifiedChapterObject::Type] The object type.
+      #
+      #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the chap
+      #
+      #   @param available_markets [Array<String>] A list of the countries in which the chapter can be played, identified by their
+      #
+      #   @param restrictions [Spotted::Models::ChapterRestrictionObject] Included in the response when a content restriction is applied.
+      #
+      #   @param resume_point [Spotted::Models::ResumePointObject] The user's most recent position in the chapter. Set if the supplied access token
+
+      # The precision with which `release_date` value is known.
+      #
+      # @see Spotted::Models::SimplifiedChapterObject#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::SimplifiedChapterObject#type
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        EPISODE = :episode
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/spotted/models/simplified_episode_object.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class SimplifiedEpisodeObject < 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::SimplifiedEpisodeObject::ReleaseDatePrecision]
+      required :release_date_precision, enum: -> { Spotted::SimplifiedEpisodeObject::ReleaseDatePrecision }
+
+      # @!attribute type
+      #   The object type.
+      #
+      #   @return [Symbol, Spotted::Models::SimplifiedEpisodeObject::Type]
+      required :type, enum: -> { Spotted::SimplifiedEpisodeObject::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:, type:, uri:, language: nil, restrictions: nil, resume_point: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::SimplifiedEpisodeObject} 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::SimplifiedEpisodeObject::ReleaseDatePrecision] The precision with which `release_date` value is known.
+      #
+      #   @param type [Symbol, Spotted::Models::SimplifiedEpisodeObject::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::SimplifiedEpisodeObject#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::SimplifiedEpisodeObject#type
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        EPISODE = :episode
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/spotted/models/simplified_playlist_object.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class SimplifiedPlaylistObject < Spotted::Internal::Type::BaseModel
+      # @!attribute id
+      #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   playlist.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute collaborative
+      #   `true` if the owner allows other users to modify the playlist.
+      #
+      #   @return [Boolean, nil]
+      optional :collaborative, Spotted::Internal::Type::Boolean
+
+      # @!attribute description
+      #   The playlist description. _Only returned for modified, verified playlists,
+      #   otherwise_ `null`.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute external_urls
+      #   Known external URLs for this playlist.
+      #
+      #   @return [Spotted::Models::ExternalURLObject, nil]
+      optional :external_urls, -> { Spotted::ExternalURLObject }
+
+      # @!attribute href
+      #   A link to the Web API endpoint providing full details of the playlist.
+      #
+      #   @return [String, nil]
+      optional :href, String
+
+      # @!attribute images
+      #   Images for the playlist. The array may be empty or contain up to three images.
+      #   The images are returned by size in descending order. See
+      #   [Working with Playlists](/documentation/web-api/concepts/playlists). _**Note**:
+      #   If returned, the source URL for the image (`url`) is temporary and will expire
+      #   in less than a day._
+      #
+      #   @return [Array<Spotted::Models::ImageObject>, nil]
+      optional :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+      # @!attribute name
+      #   The name of the playlist.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute owner
+      #   The user who owns the playlist
+      #
+      #   @return [Spotted::Models::SimplifiedPlaylistObject::Owner, nil]
+      optional :owner, -> { Spotted::SimplifiedPlaylistObject::Owner }
+
+      # @!attribute public
+      #   The playlist's public/private status (if it is added to the user's profile):
+      #   `true` the playlist is public, `false` the playlist is private, `null` the
+      #   playlist status is not relevant. For more about public/private status, see
+      #   [Working with Playlists](/documentation/web-api/concepts/playlists)
+      #
+      #   @return [Boolean, nil]
+      optional :public, Spotted::Internal::Type::Boolean
+
+      # @!attribute snapshot_id
+      #   The version identifier for the current playlist. Can be supplied in other
+      #   requests to target a specific playlist version
+      #
+      #   @return [String, nil]
+      optional :snapshot_id, String
+
+      # @!attribute tracks
+      #   A collection containing a link ( `href` ) to the Web API endpoint where full
+      #   details of the playlist's tracks can be retrieved, along with the `total` number
+      #   of tracks in the playlist. Note, a track object may be `null`. This can happen
+      #   if a track is no longer available.
+      #
+      #   @return [Spotted::Models::PlaylistTracksRefObject, nil]
+      optional :tracks, -> { Spotted::PlaylistTracksRefObject }
+
+      # @!attribute type
+      #   The object type: "playlist"
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!attribute uri
+      #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   playlist.
+      #
+      #   @return [String, nil]
+      optional :uri, String
+
+      # @!method initialize(id: nil, collaborative: nil, description: nil, external_urls: nil, href: nil, images: nil, name: nil, owner: nil, public: nil, snapshot_id: nil, tracks: nil, type: nil, uri: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::SimplifiedPlaylistObject} for more details.
+      #
+      #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the playl
+      #
+      #   @param collaborative [Boolean] `true` if the owner allows other users to modify the playlist.
+      #
+      #   @param description [String] The playlist description. \_Only returned for modified, verified playlists,
+      #   other
+      #
+      #   @param external_urls [Spotted::Models::ExternalURLObject] Known external URLs for this playlist.
+      #
+      #   @param href [String] A link to the Web API endpoint providing full details of the playlist.
+      #
+      #   @param images [Array<Spotted::Models::ImageObject>] Images for the playlist. The array may be empty or contain up to three images. T
+      #
+      #   @param name [String] The name of the playlist.
+      #
+      #   @param owner [Spotted::Models::SimplifiedPlaylistObject::Owner] The user who owns the playlist
+      #
+      #   @param public [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
+      #
+      #   @param snapshot_id [String] The version identifier for the current playlist. Can be supplied in other reques
+      #
+      #   @param tracks [Spotted::Models::PlaylistTracksRefObject] A collection containing a link ( `href` ) to the Web API endpoint where full det
+      #
+      #   @param type [String] The object type: "playlist"
+      #
+      #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the play
+
+      # @see Spotted::Models::SimplifiedPlaylistObject#owner
+      class Owner < Spotted::Models::PlaylistUserObject
+        # @!attribute display_name
+        #   The name displayed on the user's profile. `null` if not available.
+        #
+        #   @return [String, nil]
+        optional :display_name, String, nil?: true
+
+        # @!method initialize(display_name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::SimplifiedPlaylistObject::Owner} for more details.
+        #
+        #   The user who owns the playlist
+        #
+        #   @param display_name [String, nil] The name displayed on the user's profile. `null` if not available.
+      end
+    end
+  end
+end