spotted 0.1.0

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Tracks#remove
+      class TrackRemoveParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute body_ids
+        #   A JSON array of the
+        #   [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+        #   `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50 items
+        #   can be specified in one request. _**Note**: if the `ids` parameter is present in
+        #   the query string, any IDs listed here in the body will be ignored._
+        #
+        #   @return [Array<String>, nil]
+        optional :body_ids, Spotted::Internal::Type::ArrayOf[String], api_name: :ids
+
+        # @!method initialize(body_ids: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::TrackRemoveParams} for more details.
+        #
+        #   @param body_ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Tracks#save
+      class TrackSaveParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute ids
+        #   A JSON array of the
+        #   [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+        #   `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50 items
+        #   can be specified in one request. _**Note**: if the `timestamped_ids` is present
+        #   in the body, any IDs listed in the query parameters (deprecated) or the `ids`
+        #   field in the body will be ignored._
+        #
+        #   @return [Array<String>]
+        required :ids, Spotted::Internal::Type::ArrayOf[String]
+
+        # @!attribute timestamped_ids
+        #   A JSON array of objects containing track IDs with their corresponding
+        #   timestamps. Each object must include a track ID and an `added_at` timestamp.
+        #   This allows you to specify when tracks were added to maintain a specific
+        #   chronological order in the user's library.<br/>A maximum of 50 items can be
+        #   specified in one request. _**Note**: if the `timestamped_ids` is present in the
+        #   body, any IDs listed in the query parameters (deprecated) or the `ids` field in
+        #   the body will be ignored._
+        #
+        #   @return [Array<Spotted::Models::Me::TrackSaveParams::TimestampedID>, nil]
+        optional :timestamped_ids,
+                 -> { Spotted::Internal::Type::ArrayOf[Spotted::Me::TrackSaveParams::TimestampedID] }
+
+        # @!method initialize(ids:, timestamped_ids: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::TrackSaveParams} for more details.
+        #
+        #   @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
+        #
+        #   @param timestamped_ids [Array<Spotted::Models::Me::TrackSaveParams::TimestampedID>] A JSON array of objects containing track IDs with their corresponding timestamps
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+
+        class TimestampedID < Spotted::Internal::Type::BaseModel
+          # @!attribute id
+          #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+          #   track.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute added_at
+          #   The timestamp when the track was added to the library. Use ISO 8601 format with
+          #   UTC timezone (e.g., `2023-01-15T14:30:00Z`). You can specify past timestamps to
+          #   insert tracks at specific positions in the library's chronological order. The
+          #   API uses minute-level granularity for ordering, though the timestamp supports
+          #   millisecond precision.
+          #
+          #   @return [Time]
+          required :added_at, Time
+
+          # @!method initialize(id:, added_at:)
+          #   Some parameter documentations has been truncated, see
+          #   {Spotted::Models::Me::TrackSaveParams::TimestampedID} for more details.
+          #
+          #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the track
+          #
+          #   @param added_at [Time] The timestamp when the track was added to the library. Use ISO 8601 format with
+        end
+      end
+    end
+  end
+end

data/lib/spotted/models/me_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Me#retrieve
+    class MeRetrieveParams < 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/me_retrieve_response.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Me#retrieve
+    class MeRetrieveResponse < Spotted::Internal::Type::BaseModel
+      # @!attribute id
+      #   The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   user.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute country
+      #   The country of the user, as set in the user's account profile. An
+      #   [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+      #   _This field is only available when the current user has granted access to the
+      #   [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
+      #   scope._
+      #
+      #   @return [String, nil]
+      optional :country, String
+
+      # @!attribute display_name
+      #   The name displayed on the user's profile. `null` if not available.
+      #
+      #   @return [String, nil]
+      optional :display_name, String
+
+      # @!attribute email
+      #   The user's email address, as entered by the user when creating their account.
+      #   _**Important!** This email address is unverified; there is no proof that it
+      #   actually belongs to the user._ _This field is only available when the current
+      #   user has granted access to the
+      #   [user-read-email](/documentation/web-api/concepts/scopes/#list-of-scopes)
+      #   scope._
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute explicit_content
+      #   The user's explicit content settings. _This field is only available when the
+      #   current user has granted access to the
+      #   [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
+      #   scope._
+      #
+      #   @return [Spotted::Models::MeRetrieveResponse::ExplicitContent, nil]
+      optional :explicit_content, -> { Spotted::Models::MeRetrieveResponse::ExplicitContent }
+
+      # @!attribute external_urls
+      #   Known external URLs for this user.
+      #
+      #   @return [Spotted::Models::ExternalURLObject, nil]
+      optional :external_urls, -> { Spotted::ExternalURLObject }
+
+      # @!attribute followers
+      #   Information about the followers of the user.
+      #
+      #   @return [Spotted::Models::FollowersObject, nil]
+      optional :followers, -> { Spotted::FollowersObject }
+
+      # @!attribute href
+      #   A link to the Web API endpoint for this user.
+      #
+      #   @return [String, nil]
+      optional :href, String
+
+      # @!attribute images
+      #   The user's profile image.
+      #
+      #   @return [Array<Spotted::Models::ImageObject>, nil]
+      optional :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+      # @!attribute product
+      #   The user's Spotify subscription level: "premium", "free", etc. (The subscription
+      #   level "open" can be considered the same as "free".) _This field is only
+      #   available when the current user has granted access to the
+      #   [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
+      #   scope._
+      #
+      #   @return [String, nil]
+      optional :product, String
+
+      # @!attribute type
+      #   The object type: "user"
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!attribute uri
+      #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   user.
+      #
+      #   @return [String, nil]
+      optional :uri, String
+
+      # @!method initialize(id: nil, country: nil, display_name: nil, email: nil, explicit_content: nil, external_urls: nil, followers: nil, href: nil, images: nil, product: nil, type: nil, uri: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::MeRetrieveResponse} for more details.
+      #
+      #   @param id [String] The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #
+      #   @param country [String] The country of the user, as set in the user's account profile. An [ISO 3166-1 al
+      #
+      #   @param display_name [String] The name displayed on the user's profile. `null` if not available.
+      #
+      #   @param email [String] The user's email address, as entered by the user when creating their account.
+      #   \_\*
+      #
+      #   @param explicit_content [Spotted::Models::MeRetrieveResponse::ExplicitContent] The user's explicit content settings. \_This field is only available when the
+      #   cur
+      #
+      #   @param external_urls [Spotted::Models::ExternalURLObject] Known external URLs for this user.
+      #
+      #   @param followers [Spotted::Models::FollowersObject] Information about the followers of the user.
+      #
+      #   @param href [String] A link to the Web API endpoint for this user.
+      #
+      #   @param images [Array<Spotted::Models::ImageObject>] The user's profile image.
+      #
+      #   @param product [String] The user's Spotify subscription level: "premium", "free", etc. (The subscription
+      #
+      #   @param type [String] The object type: "user"
+      #
+      #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the user
+
+      # @see Spotted::Models::MeRetrieveResponse#explicit_content
+      class ExplicitContent < Spotted::Internal::Type::BaseModel
+        # @!attribute filter_enabled
+        #   When `true`, indicates that explicit content should not be played.
+        #
+        #   @return [Boolean, nil]
+        optional :filter_enabled, Spotted::Internal::Type::Boolean
+
+        # @!attribute filter_locked
+        #   When `true`, indicates that the explicit content setting is locked and can't be
+        #   changed by the user.
+        #
+        #   @return [Boolean, nil]
+        optional :filter_locked, Spotted::Internal::Type::Boolean
+
+        # @!method initialize(filter_enabled: nil, filter_locked: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::MeRetrieveResponse::ExplicitContent} for more details.
+        #
+        #   The user's explicit content settings. _This field is only available when the
+        #   current user has granted access to the
+        #   [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
+        #   scope._
+        #
+        #   @param filter_enabled [Boolean] When `true`, indicates that explicit content should not be played.
+        #
+        #   @param filter_locked [Boolean] When `true`, indicates that the explicit content setting is locked and can't be
+      end
+    end
+  end
+end

data/lib/spotted/models/narrator_object.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class NarratorObject < Spotted::Internal::Type::BaseModel
+      # @!attribute name
+      #   The name of the Narrator.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::NarratorObject} for more details.
+      #
+      #   @param name [String] The name of the Narrator.
+    end
+  end
+end

data/lib/spotted/models/paging_playlist_object.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class PagingPlaylistObject < 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::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).
+      #
+      #   @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::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)
+      #
+      #   @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

data/lib/spotted/models/playlist_retrieve_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Playlists#retrieve
+    class PlaylistRetrieveParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!attribute additional_types
+      #   A comma-separated list of item types that your client supports besides the
+      #   default `track` type. Valid types are: `track` and `episode`.<br/> _**Note**:
+      #   This parameter was introduced to allow existing clients to maintain their
+      #   current behaviour and might be deprecated in the future._<br/> In addition to
+      #   providing this parameter, make sure that your client properly handles cases of
+      #   new types in the future by checking against the `type` field of each object.
+      #
+      #   @return [String, nil]
+      optional :additional_types, String
+
+      # @!attribute fields
+      #   Filters for the query: a comma-separated list of the fields to return. If
+      #   omitted, all fields are returned. For example, to get just the playlist''s
+      #   description and URI: `fields=description,uri`. A dot separator can be used to
+      #   specify non-reoccurring fields, while parentheses can be used to specify
+      #   reoccurring fields within objects. For example, to get just the added date and
+      #   user ID of the adder: `fields=tracks.items(added_at,added_by.id)`. Use multiple
+      #   parentheses to drill down into nested objects, for example:
+      #   `fields=tracks.items(track(name,href,album(name,href)))`. Fields can be excluded
+      #   by prefixing them with an exclamation mark, for example:
+      #   `fields=tracks.items(track(name,href,album(!name,href)))`
+      #
+      #   @return [String, nil]
+      optional :fields, 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(additional_types: nil, fields: nil, market: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::PlaylistRetrieveParams} for more details.
+      #
+      #   @param additional_types [String] A comma-separated list of item types that your client supports besides the defau
+      #
+      #   @param fields [String] Filters for the query: a comma-separated list of the
+      #
+      #   @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/playlist_retrieve_response.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Playlists#retrieve
+    class PlaylistRetrieveResponse < 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, nil?: true
+
+      # @!attribute external_urls
+      #   Known external URLs for this playlist.
+      #
+      #   @return [Spotted::Models::ExternalURLObject, nil]
+      optional :external_urls, -> { Spotted::ExternalURLObject }
+
+      # @!attribute followers
+      #   Information about the followers of the playlist.
+      #
+      #   @return [Spotted::Models::FollowersObject, nil]
+      optional :followers, -> { Spotted::FollowersObject }
+
+      # @!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::PlaylistRetrieveResponse::Owner, nil]
+      optional :owner, -> { Spotted::Models::PlaylistRetrieveResponse::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
+      #   The tracks of the playlist.
+      #
+      #   @return [Spotted::Models::PlaylistRetrieveResponse::Tracks, nil]
+      optional :tracks, -> { Spotted::Models::PlaylistRetrieveResponse::Tracks }
+
+      # @!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, followers: 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::PlaylistRetrieveResponse} 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, nil] The playlist description. \_Only returned for modified, verified playlists,
+      #   other
+      #
+      #   @param external_urls [Spotted::Models::ExternalURLObject] Known external URLs for this playlist.
+      #
+      #   @param followers [Spotted::Models::FollowersObject] Information about the followers of the 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::PlaylistRetrieveResponse::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::PlaylistRetrieveResponse::Tracks] The tracks of the playlist.
+      #
+      #   @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::PlaylistRetrieveResponse#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::PlaylistRetrieveResponse::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
+
+      # @see Spotted::Models::PlaylistRetrieveResponse#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::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).
+        #
+        #   @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::PlaylistRetrieveResponse::Tracks} for more details.
+        #
+        #   The tracks of the playlist.
+        #
+        #   @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)
+        #
+        #   @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