spotted 0.23.0 → 0.25.0

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

data/rbi/spotted/models/me/track_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 track.
         sig { returns(T.nilable(Spotted::TrackObject)) }
         attr_reader :track
@@ -31,9 +42,11 @@ module Spotted
         attr_writer :track
 
         sig do
-          params(added_at: Time, track: Spotted::TrackObject::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            added_at: Time,
+            published: T::Boolean,
+            track: Spotted::TrackObject::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # The date and time the track was saved. Timestamps are returned in ISO 8601
@@ -42,13 +55,25 @@ module Spotted
           # album release), an 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 track.
           track: nil
         )
         end
 
         sig do
-          override.returns({ added_at: Time, track: Spotted::TrackObject })
+          override.returns(
+            {
+              added_at: Time,
+              published: T::Boolean,
+              track: Spotted::TrackObject
+            }
+          )
         end
         def to_hash
         end

data/rbi/spotted/models/me_retrieve_response.rbi

@@ -102,6 +102,17 @@ module Spotted
       sig { params(product: String).void }
       attr_writer :product
 
+      # 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: "user"
       sig { returns(T.nilable(String)) }
       attr_reader :type
@@ -130,6 +141,7 @@ module Spotted
           href: String,
           images: T::Array[Spotted::ImageObject::OrHash],
           product: String,
+          published: T::Boolean,
           type: String,
           uri: String
         ).returns(T.attached_class)
@@ -172,6 +184,12 @@ module Spotted
         # [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
         # scope._
         product: 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: "user"
         type: nil,
         # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -194,6 +212,7 @@ module Spotted
             href: String,
             images: T::Array[Spotted::ImageObject],
             product: String,
+            published: T::Boolean,
             type: String,
             uri: String
           }
@@ -226,27 +245,50 @@ module Spotted
         sig { params(filter_locked: T::Boolean).void }
         attr_writer :filter_locked
 
+        # 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 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._
         sig do
-          params(filter_enabled: T::Boolean, filter_locked: T::Boolean).returns(
-            T.attached_class
-          )
+          params(
+            filter_enabled: T::Boolean,
+            filter_locked: T::Boolean,
+            published: T::Boolean
+          ).returns(T.attached_class)
         end
         def self.new(
           # When `true`, indicates that explicit content should not be played.
           filter_enabled: nil,
           # When `true`, indicates that the explicit content setting is locked and can't be
           # changed by the user.
-          filter_locked: nil
+          filter_locked: 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(
-            { filter_enabled: T::Boolean, filter_locked: T::Boolean }
+            {
+              filter_enabled: T::Boolean,
+              filter_locked: T::Boolean,
+              published: T::Boolean
+            }
           )
         end
         def to_hash

data/rbi/spotted/models/narrator_object.rbi

@@ -15,14 +15,33 @@ module Spotted
       sig { params(name: String).void }
       attr_writer :name
 
-      sig { params(name: String).returns(T.attached_class) }
+      # 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(name: String, published: T::Boolean).returns(T.attached_class)
+      end
       def self.new(
         # The name of the Narrator.
-        name: nil
+        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
       )
       end
 
-      sig { override.returns({ name: String }) }
+      sig { override.returns({ name: String, published: T::Boolean }) }
       def to_hash
       end
     end

data/rbi/spotted/models/paging_playlist_object.rbi

@@ -40,6 +40,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
+
       sig do
         params(
           href: String,
@@ -48,7 +59,8 @@ module Spotted
           offset: Integer,
           previous: T.nilable(String),
           total: Integer,
-          items: T::Array[Spotted::SimplifiedPlaylistObject::OrHash]
+          items: T::Array[Spotted::SimplifiedPlaylistObject::OrHash],
+          published: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -64,7 +76,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
 
@@ -77,7 +95,8 @@ module Spotted
             offset: Integer,
             previous: T.nilable(String),
             total: Integer,
-            items: T::Array[Spotted::SimplifiedPlaylistObject]
+            items: T::Array[Spotted::SimplifiedPlaylistObject],
+            published: T::Boolean
           }
         )
       end

data/rbi/spotted/models/playlist_retrieve_response.rbi

@@ -83,15 +83,16 @@ module Spotted
       end
       attr_writer :owner
 
-      # 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
+      # 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 :public
+      attr_reader :published
 
-      sig { params(public: T::Boolean).void }
-      attr_writer :public
+      sig { params(published: T::Boolean).void }
+      attr_writer :published
 
       # The version identifier for the current playlist. Can be supplied in other
       # requests to target a specific playlist version
@@ -140,7 +141,7 @@ module Spotted
           images: T::Array[Spotted::ImageObject::OrHash],
           name: String,
           owner: Spotted::Models::PlaylistRetrieveResponse::Owner::OrHash,
-          public: T::Boolean,
+          published: T::Boolean,
           snapshot_id: String,
           tracks: Spotted::Models::PlaylistRetrieveResponse::Tracks::OrHash,
           type: String,
@@ -172,11 +173,12 @@ module Spotted
         name: nil,
         # The user who owns the playlist
         owner: nil,
-        # 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
+        # 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)
-        public: nil,
+        published: nil,
         # The version identifier for the current playlist. Can be supplied in other
         # requests to target a specific playlist version
         snapshot_id: nil,
@@ -202,7 +204,7 @@ module Spotted
             images: T::Array[Spotted::ImageObject],
             name: String,
             owner: Spotted::Models::PlaylistRetrieveResponse::Owner,
-            public: T::Boolean,
+            published: T::Boolean,
             snapshot_id: String,
             tracks: Spotted::Models::PlaylistRetrieveResponse::Tracks,
             type: String,
@@ -282,6 +284,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 tracks of the playlist.
         sig do
           params(
@@ -291,7 +304,8 @@ module Spotted
             offset: Integer,
             previous: T.nilable(String),
             total: Integer,
-            items: T::Array[Spotted::PlaylistTrackObject::OrHash]
+            items: T::Array[Spotted::PlaylistTrackObject::OrHash],
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -307,7 +321,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
 
@@ -320,7 +340,8 @@ module Spotted
               offset: Integer,
               previous: T.nilable(String),
               total: Integer,
-              items: T::Array[Spotted::PlaylistTrackObject]
+              items: T::Array[Spotted::PlaylistTrackObject],
+              published: T::Boolean
             }
           )
         end

data/rbi/spotted/models/playlist_track_object.rbi

@@ -32,6 +32,17 @@ module Spotted
       sig { params(is_local: T::Boolean).void }
       attr_writer :is_local
 
+      # 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 track or episode.
       sig { returns(T.nilable(Spotted::PlaylistTrackObject::Track::Variants)) }
       attr_reader :track
@@ -49,6 +60,7 @@ module Spotted
           added_at: Time,
           added_by: Spotted::PlaylistUserObject::OrHash,
           is_local: T::Boolean,
+          published: T::Boolean,
           track:
             T.any(Spotted::TrackObject::OrHash, Spotted::EpisodeObject::OrHash)
         ).returns(T.attached_class)
@@ -63,6 +75,12 @@ module Spotted
         # Whether this track or episode is a
         # [local file](/documentation/web-api/concepts/playlists/#local-files) or not.
         is_local: 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 track or episode.
         track: nil
       )
@@ -74,6 +92,7 @@ module Spotted
             added_at: Time,
             added_by: Spotted::PlaylistUserObject,
             is_local: T::Boolean,
+            published: T::Boolean,
             track: Spotted::PlaylistTrackObject::Track::Variants
           }
         )

data/rbi/spotted/models/playlist_tracks_ref_object.rbi

@@ -16,6 +16,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
+
       # Number of tracks in the playlist.
       sig { returns(T.nilable(Integer)) }
       attr_reader :total
@@ -23,17 +34,31 @@ module Spotted
       sig { params(total: Integer).void }
       attr_writer :total
 
-      sig { params(href: String, total: Integer).returns(T.attached_class) }
+      sig do
+        params(href: String, published: T::Boolean, total: Integer).returns(
+          T.attached_class
+        )
+      end
       def self.new(
         # A link to the Web API endpoint where full details of the playlist's tracks can
         # be retrieved.
         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,
         # Number of tracks in the playlist.
         total: nil
       )
       end
 
-      sig { override.returns({ href: String, total: Integer }) }
+      sig do
+        override.returns(
+          { href: String, published: T::Boolean, total: Integer }
+        )
+      end
       def to_hash
       end
     end