spotted 0.11.0 → 0.12.0

data/lib/spotted/models/chapter_bulk_retrieve_response.rb

@@ -122,8 +122,8 @@ module Spotted
         # @!attribute type
         #   The object type.
         #
-        #   @return [Symbol, Spotted::Models::ChapterBulkRetrieveResponse::Chapter::Type]
-        required :type, enum: -> { Spotted::Models::ChapterBulkRetrieveResponse::Chapter::Type }
+        #   @return [Symbol, :episode]
+        required :type, const: :episode
 
         # @!attribute uri
         #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -152,7 +152,7 @@ module Spotted
         #   @return [Spotted::Models::ResumePointObject, nil]
         optional :resume_point, -> { Spotted::ResumePointObject }
 
-        # @!method initialize(id:, audio_preview_url:, audiobook:, 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)
+        # @!method initialize(id:, audio_preview_url:, audiobook:, chapter_number:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_playable:, languages:, name:, release_date:, release_date_precision:, uri:, available_markets: nil, restrictions: nil, resume_point: nil, type: :episode)
         #   Some parameter documentations has been truncated, see
         #   {Spotted::Models::ChapterBulkRetrieveResponse::Chapter} for more details.
         #
@@ -188,8 +188,6 @@ module Spotted
         #
         #   @param release_date_precision [Symbol, Spotted::Models::ChapterBulkRetrieveResponse::Chapter::ReleaseDatePrecision] The precision with which `release_date` value is known.
         #
-        #   @param type [Symbol, Spotted::Models::ChapterBulkRetrieveResponse::Chapter::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
@@ -197,6 +195,8 @@ module Spotted
         #   @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
+        #
+        #   @param type [Symbol, :episode] The object type.
 
         # The precision with which `release_date` value is known.
         #
@@ -211,18 +211,6 @@ module Spotted
           # @!method self.values
           #   @return [Array<Symbol>]
         end
-
-        # The object type.
-        #
-        # @see Spotted::Models::ChapterBulkRetrieveResponse::Chapter#type
-        module Type
-          extend Spotted::Internal::Type::Enum
-
-          EPISODE = :episode
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
       end
     end
   end

data/lib/spotted/models/chapter_retrieve_response.rb

@@ -112,8 +112,8 @@ module Spotted
       # @!attribute type
       #   The object type.
       #
-      #   @return [Symbol, Spotted::Models::ChapterRetrieveResponse::Type]
-      required :type, enum: -> { Spotted::Models::ChapterRetrieveResponse::Type }
+      #   @return [Symbol, :episode]
+      required :type, const: :episode
 
       # @!attribute uri
       #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -142,7 +142,7 @@ module Spotted
       #   @return [Spotted::Models::ResumePointObject, nil]
       optional :resume_point, -> { Spotted::ResumePointObject }
 
-      # @!method initialize(id:, audio_preview_url:, audiobook:, 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)
+      # @!method initialize(id:, audio_preview_url:, audiobook:, chapter_number:, description:, duration_ms:, explicit:, external_urls:, href:, html_description:, images:, is_playable:, languages:, name:, release_date:, release_date_precision:, uri:, available_markets: nil, restrictions: nil, resume_point: nil, type: :episode)
       #   Some parameter documentations has been truncated, see
       #   {Spotted::Models::ChapterRetrieveResponse} for more details.
       #
@@ -178,8 +178,6 @@ module Spotted
       #
       #   @param release_date_precision [Symbol, Spotted::Models::ChapterRetrieveResponse::ReleaseDatePrecision] The precision with which `release_date` value is known.
       #
-      #   @param type [Symbol, Spotted::Models::ChapterRetrieveResponse::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
@@ -187,6 +185,8 @@ module Spotted
       #   @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
+      #
+      #   @param type [Symbol, :episode] The object type.
 
       # The precision with which `release_date` value is known.
       #
@@ -201,18 +201,6 @@ module Spotted
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      # The object type.
-      #
-      # @see Spotted::Models::ChapterRetrieveResponse#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_object.rb

@@ -110,8 +110,8 @@ module Spotted
       # @!attribute type
       #   The object type.
       #
-      #   @return [Symbol, Spotted::Models::EpisodeObject::Type]
-      required :type, enum: -> { Spotted::EpisodeObject::Type }
+      #   @return [Symbol, :episode]
+      required :type, const: :episode
 
       # @!attribute uri
       #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -143,7 +143,7 @@ module Spotted
       #   @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)
+      # @!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:, uri:, language: nil, restrictions: nil, resume_point: nil, type: :episode)
       #   Some parameter documentations has been truncated, see
       #   {Spotted::Models::EpisodeObject} for more details.
       #
@@ -179,8 +179,6 @@ module Spotted
       #
       #   @param show [Spotted::Models::ShowBase] 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
@@ -188,6 +186,8 @@ module Spotted
       #   @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
+      #
+      #   @param type [Symbol, :episode] The object type.
 
       # The precision with which `release_date` value is known.
       #
@@ -202,18 +202,6 @@ module Spotted
         # @!method self.values
         #   @return [Array<Symbol>]
       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/me/album_list_response.rb

@@ -100,8 +100,8 @@ module Spotted
           # @!attribute type
           #   The object type.
           #
-          #   @return [Symbol, Spotted::Models::Me::AlbumListResponse::Album::Type]
-          required :type, enum: -> { Spotted::Models::Me::AlbumListResponse::Album::Type }
+          #   @return [Symbol, :album]
+          required :type, const: :album
 
           # @!attribute uri
           #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -162,7 +162,7 @@ module Spotted
           #   @return [Spotted::Models::Me::AlbumListResponse::Album::Tracks, nil]
           optional :tracks, -> { Spotted::Models::Me::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)
+          # @!method initialize(id:, album_type:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, uri:, artists: nil, copyrights: nil, external_ids: nil, genres: nil, label: nil, popularity: nil, restrictions: nil, tracks: nil, type: :album)
           #   Some parameter documentations has been truncated, see
           #   {Spotted::Models::Me::AlbumListResponse::Album} for more details.
           #
@@ -188,8 +188,6 @@ module Spotted
           #
           #   @param total_tracks [Integer] The number of tracks in the album.
           #
-          #   @param type [Symbol, Spotted::Models::Me::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
@@ -207,6 +205,8 @@ module Spotted
           #   @param restrictions [Spotted::Models::AlbumRestrictionObject] Included in the response when a content restriction is applied.
           #
           #   @param tracks [Spotted::Models::Me::AlbumListResponse::Album::Tracks] The tracks of the album.
+          #
+          #   @param type [Symbol, :album] The object type.
 
           # The type of the album.
           #
@@ -236,18 +236,6 @@ module Spotted
             #   @return [Array<Symbol>]
           end
 
-          # The object type.
-          #
-          # @see Spotted::Models::Me::AlbumListResponse::Album#type
-          module Type
-            extend Spotted::Internal::Type::Enum
-
-            ALBUM = :album
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
           # @see Spotted::Models::Me::AlbumListResponse::Album#tracks
           class Tracks < Spotted::Internal::Type::BaseModel
             # @!attribute href
@@ -256,11 +244,6 @@ module Spotted
             #   @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).
             #
@@ -291,7 +274,12 @@ module Spotted
             #   @return [Integer]
             required :total, Integer
 
-            # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
+            # @!attribute items
+            #
+            #   @return [Array<Spotted::Models::SimplifiedTrackObject>, nil]
+            optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedTrackObject] }
+
+            # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
             #   Some parameter documentations has been truncated, see
             #   {Spotted::Models::Me::AlbumListResponse::Album::Tracks} for more details.
             #
@@ -299,8 +287,6 @@ module Spotted
             #
             #   @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)
@@ -310,6 +296,8 @@ module Spotted
             #   @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.
+            #
+            #   @param items [Array<Spotted::Models::SimplifiedTrackObject>]
           end
         end
       end

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

@@ -52,11 +52,6 @@ module Spotted
             #   @return [String]
             required :href, String
 
-            # @!attribute items
-            #
-            #   @return [Array<Spotted::Models::SimplifiedChapterObject>]
-            required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedChapterObject] }
-
             # @!attribute limit
             #   The maximum number of items in the response (as set in the query or by default).
             #
@@ -87,7 +82,12 @@ module Spotted
             #   @return [Integer]
             required :total, Integer
 
-            # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
+            # @!attribute items
+            #
+            #   @return [Array<Spotted::Models::SimplifiedChapterObject>, nil]
+            optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedChapterObject] }
+
+            # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
             #   Some parameter documentations has been truncated, see
             #   {Spotted::Models::Me::AudiobookListResponse::Audiobook::Chapters} for more
             #   details.
@@ -96,8 +96,6 @@ module Spotted
             #
             #   @param href [String] A link to the Web API endpoint returning the full result of the request
             #
-            #   @param items [Array<Spotted::Models::SimplifiedChapterObject>]
-            #
             #   @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)
@@ -107,6 +105,8 @@ module Spotted
             #   @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.
+            #
+            #   @param items [Array<Spotted::Models::SimplifiedChapterObject>]
           end
         end
       end

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

@@ -11,8 +11,8 @@ module Spotted
         # @!attribute type
         #   The ID type: currently only `artist` is supported.
         #
-        #   @return [Symbol, Spotted::Models::Me::FollowingBulkRetrieveParams::Type]
-        required :type, enum: -> { Spotted::Me::FollowingBulkRetrieveParams::Type }
+        #   @return [Symbol, :artist]
+        required :type, const: :artist
 
         # @!attribute after
         #   The last artist ID retrieved from the previous request.
@@ -26,27 +26,17 @@ module Spotted
         #   @return [Integer, nil]
         optional :limit, Integer
 
-        # @!method initialize(type:, after: nil, limit: nil, request_options: {})
+        # @!method initialize(after: nil, limit: nil, type: :artist, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Spotted::Models::Me::FollowingBulkRetrieveParams} for more details.
         #
-        #   @param type [Symbol, Spotted::Models::Me::FollowingBulkRetrieveParams::Type] The ID type: currently only `artist` is supported.
-        #
         #   @param after [String] The last artist ID retrieved from the previous request.
         #
         #   @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
         #
+        #   @param type [Symbol, :artist] The ID type: currently only `artist` is supported.
+        #
         #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
-
-        # The ID type: currently only `artist` is supported.
-        module Type
-          extend Spotted::Internal::Type::Enum
-
-          ARTIST = :artist
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
       end
     end
   end

data/lib/spotted/models/paging_playlist_object.rb

@@ -9,11 +9,6 @@ module Spotted
       #   @return [String]
       required :href, String
 
-      # @!attribute items
-      #
-      #   @return [Array<Spotted::Models::SimplifiedPlaylistObject>]
-      required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedPlaylistObject] }
-
       # @!attribute limit
       #   The maximum number of items in the response (as set in the query or by default).
       #
@@ -44,14 +39,17 @@ module Spotted
       #   @return [Integer]
       required :total, Integer
 
-      # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
+      # @!attribute items
+      #
+      #   @return [Array<Spotted::Models::SimplifiedPlaylistObject>, nil]
+      optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedPlaylistObject] }
+
+      # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
       #   Some parameter documentations has been truncated, see
       #   {Spotted::Models::PagingPlaylistObject} for more details.
       #
       #   @param href [String] A link to the Web API endpoint returning the full result of the request
       #
-      #   @param items [Array<Spotted::Models::SimplifiedPlaylistObject>]
-      #
       #   @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)
@@ -61,6 +59,8 @@ module Spotted
       #   @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.
+      #
+      #   @param items [Array<Spotted::Models::SimplifiedPlaylistObject>]
     end
   end
 end

data/lib/spotted/models/playlist_retrieve_response.rb

@@ -157,11 +157,6 @@ module Spotted
         #   @return [String]
         required :href, String
 
-        # @!attribute items
-        #
-        #   @return [Array<Spotted::Models::PlaylistTrackObject>]
-        required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::PlaylistTrackObject] }
-
         # @!attribute limit
         #   The maximum number of items in the response (as set in the query or by default).
         #
@@ -192,7 +187,12 @@ module Spotted
         #   @return [Integer]
         required :total, Integer
 
-        # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
+        # @!attribute items
+        #
+        #   @return [Array<Spotted::Models::PlaylistTrackObject>, nil]
+        optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::PlaylistTrackObject] }
+
+        # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
         #   Some parameter documentations has been truncated, see
         #   {Spotted::Models::PlaylistRetrieveResponse::Tracks} for more details.
         #
@@ -200,8 +200,6 @@ module Spotted
         #
         #   @param href [String] A link to the Web API endpoint returning the full result of the request
         #
-        #   @param items [Array<Spotted::Models::PlaylistTrackObject>]
-        #
         #   @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)
@@ -211,6 +209,8 @@ module Spotted
         #   @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.
+        #
+        #   @param items [Array<Spotted::Models::PlaylistTrackObject>]
       end
     end
   end