spotted 0.24.0 → 0.25.0

data/rbi/spotted/models/me/audiobook_list_response.rbi

@@ -39,11 +39,23 @@ module Spotted
         end
         attr_writer :audiobook
 
+        # The playlist's public/private status (if it should be added to the user's
+        # profile or not): `true` the playlist will be public, `false` the playlist will
+        # be private, `null` the playlist status is not relevant. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :published
+
+        sig { params(published: T::Boolean).void }
+        attr_writer :published
+
         sig do
           params(
             added_at: Time,
             audiobook:
-              Spotted::Models::Me::AudiobookListResponse::Audiobook::OrHash
+              Spotted::Models::Me::AudiobookListResponse::Audiobook::OrHash,
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -54,7 +66,13 @@ module Spotted
           # release_date in an album object.
           added_at: nil,
           # Information about the audiobook.
-          audiobook: nil
+          audiobook: nil,
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          published: nil
         )
         end
 
@@ -62,7 +80,8 @@ module Spotted
           override.returns(
             {
               added_at: Time,
-              audiobook: Spotted::Models::Me::AudiobookListResponse::Audiobook
+              audiobook: Spotted::Models::Me::AudiobookListResponse::Audiobook,
+              published: T::Boolean
             }
           )
         end
@@ -163,6 +182,17 @@ module Spotted
             end
             attr_writer :items
 
+            # The playlist's public/private status (if it should be added to the user's
+            # profile or not): `true` the playlist will be public, `false` the playlist will
+            # be private, `null` the playlist status is not relevant. For more about
+            # public/private status, see
+            # [Working with Playlists](/documentation/web-api/concepts/playlists)
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :published
+
+            sig { params(published: T::Boolean).void }
+            attr_writer :published
+
             # The chapters of the audiobook.
             sig do
               params(
@@ -172,7 +202,8 @@ module Spotted
                 offset: Integer,
                 previous: T.nilable(String),
                 total: Integer,
-                items: T::Array[Spotted::SimplifiedChapterObject::OrHash]
+                items: T::Array[Spotted::SimplifiedChapterObject::OrHash],
+                published: T::Boolean
               ).returns(T.attached_class)
             end
             def self.new(
@@ -188,7 +219,13 @@ module Spotted
               previous:,
               # The total number of items available to return.
               total:,
-              items: nil
+              items: nil,
+              # The playlist's public/private status (if it should be added to the user's
+              # profile or not): `true` the playlist will be public, `false` the playlist will
+              # be private, `null` the playlist status is not relevant. For more about
+              # public/private status, see
+              # [Working with Playlists](/documentation/web-api/concepts/playlists)
+              published: nil
             )
             end
 
@@ -201,7 +238,8 @@ module Spotted
                   offset: Integer,
                   previous: T.nilable(String),
                   total: Integer,
-                  items: T::Array[Spotted::SimplifiedChapterObject]
+                  items: T::Array[Spotted::SimplifiedChapterObject],
+                  published: T::Boolean
                 }
               )
             end

data/rbi/spotted/models/me/context_object.rbi

@@ -23,6 +23,17 @@ module Spotted
         sig { params(href: String).void }
         attr_writer :href
 
+        # The playlist's public/private status (if it should be added to the user's
+        # profile or not): `true` the playlist will be public, `false` the playlist will
+        # be private, `null` the playlist status is not relevant. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :published
+
+        sig { params(published: T::Boolean).void }
+        attr_writer :published
+
         # The object type, e.g. "artist", "playlist", "album", "show".
         sig { returns(T.nilable(String)) }
         attr_reader :type
@@ -42,6 +53,7 @@ module Spotted
           params(
             external_urls: Spotted::ExternalURLObject::OrHash,
             href: String,
+            published: T::Boolean,
             type: String,
             uri: String
           ).returns(T.attached_class)
@@ -51,6 +63,12 @@ module Spotted
           external_urls: nil,
           # A link to the Web API endpoint providing full details of the track.
           href: nil,
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          published: nil,
           # The object type, e.g. "artist", "playlist", "album", "show".
           type: nil,
           # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -64,6 +82,7 @@ module Spotted
             {
               external_urls: Spotted::ExternalURLObject,
               href: String,
+              published: T::Boolean,
               type: String,
               uri: String
             }

data/rbi/spotted/models/me/device_object.rbi

@@ -46,6 +46,17 @@ module Spotted
         sig { params(name: String).void }
         attr_writer :name
 
+        # The playlist's public/private status (if it should be added to the user's
+        # profile or not): `true` the playlist will be public, `false` the playlist will
+        # be private, `null` the playlist status is not relevant. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :published
+
+        sig { params(published: T::Boolean).void }
+        attr_writer :published
+
         # If this device can be used to set the volume.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :supports_volume
@@ -71,6 +82,7 @@ module Spotted
             is_private_session: T::Boolean,
             is_restricted: T::Boolean,
             name: String,
+            published: T::Boolean,
             supports_volume: T::Boolean,
             type: String,
             volume_percent: T.nilable(Integer)
@@ -92,6 +104,12 @@ module Spotted
           # configure (e.g. \"Loudest speaker\") and some devices have a generic name
           # associated with the manufacturer or device model.
           name: nil,
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          published: nil,
           # If this device can be used to set the volume.
           supports_volume: nil,
           # Device type, such as "computer", "smartphone" or "speaker".
@@ -109,6 +127,7 @@ module Spotted
               is_private_session: T::Boolean,
               is_restricted: T::Boolean,
               name: String,
+              published: T::Boolean,
               supports_volume: T::Boolean,
               type: String,
               volume_percent: T.nilable(Integer)

data/rbi/spotted/models/me/episode_list_response.rbi

@@ -28,10 +28,22 @@ module Spotted
         sig { params(episode: Spotted::EpisodeObject::OrHash).void }
         attr_writer :episode
 
+        # The playlist's public/private status (if it should be added to the user's
+        # profile or not): `true` the playlist will be public, `false` the playlist will
+        # be private, `null` the playlist status is not relevant. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :published
+
+        sig { params(published: T::Boolean).void }
+        attr_writer :published
+
         sig do
           params(
             added_at: Time,
-            episode: Spotted::EpisodeObject::OrHash
+            episode: Spotted::EpisodeObject::OrHash,
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -40,12 +52,24 @@ module Spotted
           # YYYY-MM-DDTHH:MM:SSZ.
           added_at: nil,
           # Information about the episode.
-          episode: nil
+          episode: nil,
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          published: nil
         )
         end
 
         sig do
-          override.returns({ added_at: Time, episode: Spotted::EpisodeObject })
+          override.returns(
+            {
+              added_at: Time,
+              episode: Spotted::EpisodeObject,
+              published: T::Boolean
+            }
+          )
         end
         def to_hash
         end

data/rbi/spotted/models/me/following_bulk_retrieve_response.rbi

@@ -99,6 +99,17 @@ module Spotted
           sig { params(next_: String).void }
           attr_writer :next_
 
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :published
+
+          sig { params(published: T::Boolean).void }
+          attr_writer :published
+
           # The total number of items available to return.
           sig { returns(T.nilable(Integer)) }
           attr_reader :total
@@ -114,6 +125,7 @@ module Spotted
               items: T::Array[Spotted::ArtistObject::OrHash],
               limit: Integer,
               next_: String,
+              published: T::Boolean,
               total: Integer
             ).returns(T.attached_class)
           end
@@ -127,6 +139,12 @@ module Spotted
             limit: nil,
             # URL to the next page of items. ( `null` if none)
             next_: nil,
+            # The playlist's public/private status (if it should be added to the user's
+            # profile or not): `true` the playlist will be public, `false` the playlist will
+            # be private, `null` the playlist status is not relevant. For more about
+            # public/private status, see
+            # [Working with Playlists](/documentation/web-api/concepts/playlists)
+            published: nil,
             # The total number of items available to return.
             total: nil
           )
@@ -141,6 +159,7 @@ module Spotted
                 items: T::Array[Spotted::ArtistObject],
                 limit: Integer,
                 next_: String,
+                published: T::Boolean,
                 total: Integer
               }
             )
@@ -171,19 +190,44 @@ module Spotted
             sig { params(before: String).void }
             attr_writer :before
 
+            # The playlist's public/private status (if it should be added to the user's
+            # profile or not): `true` the playlist will be public, `false` the playlist will
+            # be private, `null` the playlist status is not relevant. For more about
+            # public/private status, see
+            # [Working with Playlists](/documentation/web-api/concepts/playlists)
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :published
+
+            sig { params(published: T::Boolean).void }
+            attr_writer :published
+
             # The cursors used to find the next set of items.
             sig do
-              params(after: String, before: String).returns(T.attached_class)
+              params(
+                after: String,
+                before: String,
+                published: T::Boolean
+              ).returns(T.attached_class)
             end
             def self.new(
               # The cursor to use as key to find the next page of items.
               after: nil,
               # The cursor to use as key to find the previous page of items.
-              before: nil
+              before: nil,
+              # The playlist's public/private status (if it should be added to the user's
+              # profile or not): `true` the playlist will be public, `false` the playlist will
+              # be private, `null` the playlist status is not relevant. For more about
+              # public/private status, see
+              # [Working with Playlists](/documentation/web-api/concepts/playlists)
+              published: nil
             )
             end
 
-            sig { override.returns({ after: String, before: String }) }
+            sig do
+              override.returns(
+                { after: String, before: String, published: T::Boolean }
+              )
+            end
             def to_hash
             end
           end

data/rbi/spotted/models/me/player/queue_get_response.rbi

@@ -34,6 +34,17 @@ module Spotted
           end
           attr_writer :currently_playing
 
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :published
+
+          sig { params(published: T::Boolean).void }
+          attr_writer :published
+
           # The tracks or episodes in the queue. Can be empty.
           sig do
             returns(
@@ -66,6 +77,7 @@ module Spotted
                   Spotted::TrackObject::OrHash,
                   Spotted::EpisodeObject::OrHash
                 ),
+              published: T::Boolean,
               queue:
                 T::Array[
                   T.any(
@@ -78,6 +90,12 @@ module Spotted
           def self.new(
             # The currently playing track or episode. Can be `null`.
             currently_playing: nil,
+            # The playlist's public/private status (if it should be added to the user's
+            # profile or not): `true` the playlist will be public, `false` the playlist will
+            # be private, `null` the playlist status is not relevant. For more about
+            # public/private status, see
+            # [Working with Playlists](/documentation/web-api/concepts/playlists)
+            published: nil,
             # The tracks or episodes in the queue. Can be empty.
             queue: nil
           )
@@ -88,6 +106,7 @@ module Spotted
               {
                 currently_playing:
                   Spotted::Models::Me::Player::QueueGetResponse::CurrentlyPlaying::Variants,
+                published: T::Boolean,
                 queue:
                   T::Array[
                     Spotted::Models::Me::Player::QueueGetResponse::Queue::Variants

data/rbi/spotted/models/me/player_get_currently_playing_response.rbi

@@ -81,6 +81,17 @@ module Spotted
         sig { params(progress_ms: Integer).void }
         attr_writer :progress_ms
 
+        # The playlist's public/private status (if it should be added to the user's
+        # profile or not): `true` the playlist will be public, `false` the playlist will
+        # be private, `null` the playlist status is not relevant. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :published
+
+        sig { params(published: T::Boolean).void }
+        attr_writer :published
+
         # Unix Millisecond Timestamp when data was fetched
         sig { returns(T.nilable(Integer)) }
         attr_reader :timestamp
@@ -101,6 +112,7 @@ module Spotted
                 Spotted::EpisodeObject::OrHash
               ),
             progress_ms: Integer,
+            published: T::Boolean,
             timestamp: Integer
           ).returns(T.attached_class)
         end
@@ -119,6 +131,12 @@ module Spotted
           item: nil,
           # Progress into the currently playing track or episode. Can be `null`.
           progress_ms: nil,
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          published: nil,
           # Unix Millisecond Timestamp when data was fetched
           timestamp: nil
         )
@@ -135,6 +153,7 @@ module Spotted
               item:
                 Spotted::Models::Me::PlayerGetCurrentlyPlayingResponse::Item::Variants,
               progress_ms: Integer,
+              published: T::Boolean,
               timestamp: Integer
             }
           )
@@ -165,6 +184,17 @@ module Spotted
           sig { params(pausing: T::Boolean).void }
           attr_writer :pausing
 
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :published
+
+          sig { params(published: T::Boolean).void }
+          attr_writer :published
+
           # Resuming. Optional field.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :resuming
@@ -227,6 +257,7 @@ module Spotted
             params(
               interrupting_playback: T::Boolean,
               pausing: T::Boolean,
+              published: T::Boolean,
               resuming: T::Boolean,
               seeking: T::Boolean,
               skipping_next: T::Boolean,
@@ -242,6 +273,12 @@ module Spotted
             interrupting_playback: nil,
             # Pausing. Optional field.
             pausing: nil,
+            # The playlist's public/private status (if it should be added to the user's
+            # profile or not): `true` the playlist will be public, `false` the playlist will
+            # be private, `null` the playlist status is not relevant. For more about
+            # public/private status, see
+            # [Working with Playlists](/documentation/web-api/concepts/playlists)
+            published: nil,
             # Resuming. Optional field.
             resuming: nil,
             # Seeking playback location. Optional field.
@@ -266,6 +303,7 @@ module Spotted
               {
                 interrupting_playback: T::Boolean,
                 pausing: T::Boolean,
+                published: T::Boolean,
                 resuming: T::Boolean,
                 seeking: T::Boolean,
                 skipping_next: T::Boolean,

data/rbi/spotted/models/me/player_get_state_response.rbi

@@ -86,6 +86,17 @@ module Spotted
         sig { params(progress_ms: Integer).void }
         attr_writer :progress_ms
 
+        # The playlist's public/private status (if it should be added to the user's
+        # profile or not): `true` the playlist will be public, `false` the playlist will
+        # be private, `null` the playlist status is not relevant. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :published
+
+        sig { params(published: T::Boolean).void }
+        attr_writer :published
+
         # off, track, context
         sig { returns(T.nilable(String)) }
         attr_reader :repeat_state
@@ -122,6 +133,7 @@ module Spotted
                 Spotted::EpisodeObject::OrHash
               ),
             progress_ms: Integer,
+            published: T::Boolean,
             repeat_state: String,
             shuffle_state: T::Boolean,
             timestamp: Integer
@@ -144,6 +156,12 @@ module Spotted
           item: nil,
           # Progress into the currently playing track or episode. Can be `null`.
           progress_ms: nil,
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          published: nil,
           # off, track, context
           repeat_state: nil,
           # If shuffle is on or off.
@@ -164,6 +182,7 @@ module Spotted
               is_playing: T::Boolean,
               item: Spotted::Models::Me::PlayerGetStateResponse::Item::Variants,
               progress_ms: Integer,
+              published: T::Boolean,
               repeat_state: String,
               shuffle_state: T::Boolean,
               timestamp: Integer
@@ -196,6 +215,17 @@ module Spotted
           sig { params(pausing: T::Boolean).void }
           attr_writer :pausing
 
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :published
+
+          sig { params(published: T::Boolean).void }
+          attr_writer :published
+
           # Resuming. Optional field.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :resuming
@@ -258,6 +288,7 @@ module Spotted
             params(
               interrupting_playback: T::Boolean,
               pausing: T::Boolean,
+              published: T::Boolean,
               resuming: T::Boolean,
               seeking: T::Boolean,
               skipping_next: T::Boolean,
@@ -273,6 +304,12 @@ module Spotted
             interrupting_playback: nil,
             # Pausing. Optional field.
             pausing: nil,
+            # The playlist's public/private status (if it should be added to the user's
+            # profile or not): `true` the playlist will be public, `false` the playlist will
+            # be private, `null` the playlist status is not relevant. For more about
+            # public/private status, see
+            # [Working with Playlists](/documentation/web-api/concepts/playlists)
+            published: nil,
             # Resuming. Optional field.
             resuming: nil,
             # Seeking playback location. Optional field.
@@ -297,6 +334,7 @@ module Spotted
               {
                 interrupting_playback: T::Boolean,
                 pausing: T::Boolean,
+                published: T::Boolean,
                 resuming: T::Boolean,
                 seeking: T::Boolean,
                 skipping_next: T::Boolean,

data/rbi/spotted/models/me/player_list_recently_played_response.rbi

@@ -26,6 +26,17 @@ module Spotted
         sig { params(played_at: Time).void }
         attr_writer :played_at
 
+        # The playlist's public/private status (if it should be added to the user's
+        # profile or not): `true` the playlist will be public, `false` the playlist will
+        # be private, `null` the playlist status is not relevant. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :published
+
+        sig { params(published: T::Boolean).void }
+        attr_writer :published
+
         # The track the user listened to.
         sig { returns(T.nilable(Spotted::TrackObject)) }
         attr_reader :track
@@ -37,6 +48,7 @@ module Spotted
           params(
             context: Spotted::Me::ContextObject::OrHash,
             played_at: Time,
+            published: T::Boolean,
             track: Spotted::TrackObject::OrHash
           ).returns(T.attached_class)
         end
@@ -45,6 +57,12 @@ module Spotted
           context: nil,
           # The date and time the track was played.
           played_at: nil,
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          published: nil,
           # The track the user listened to.
           track: nil
         )
@@ -55,6 +73,7 @@ module Spotted
             {
               context: Spotted::Me::ContextObject,
               played_at: Time,
+              published: T::Boolean,
               track: Spotted::TrackObject
             }
           )

data/rbi/spotted/models/me/show_list_response.rbi

@@ -23,6 +23,17 @@ module Spotted
         sig { params(added_at: Time).void }
         attr_writer :added_at
 
+        # The playlist's public/private status (if it should be added to the user's
+        # profile or not): `true` the playlist will be public, `false` the playlist will
+        # be private, `null` the playlist status is not relevant. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :published
+
+        sig { params(published: T::Boolean).void }
+        attr_writer :published
+
         # Information about the show.
         sig { returns(T.nilable(Spotted::ShowBase)) }
         attr_reader :show
@@ -31,9 +42,11 @@ module Spotted
         attr_writer :show
 
         sig do
-          params(added_at: Time, show: Spotted::ShowBase::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            added_at: Time,
+            published: T::Boolean,
+            show: Spotted::ShowBase::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # The date and time the show was saved. Timestamps are returned in ISO 8601 format
@@ -42,12 +55,22 @@ module Spotted
           # additional field indicates the precision; see for example, release_date in an
           # album object.
           added_at: nil,
+          # The playlist's public/private status (if it should be added to the user's
+          # profile or not): `true` the playlist will be public, `false` the playlist will
+          # be private, `null` the playlist status is not relevant. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          published: nil,
           # Information about the show.
           show: nil
         )
         end
 
-        sig { override.returns({ added_at: Time, show: Spotted::ShowBase }) }
+        sig do
+          override.returns(
+            { added_at: Time, published: T::Boolean, show: Spotted::ShowBase }
+          )
+        end
         def to_hash
         end
       end