spotted 0.24.0 → 0.26.0

data/rbi/spotted/models/playlists/track_remove_params.rbi

@@ -23,6 +23,17 @@ module Spotted
         sig { returns(T::Array[Spotted::Playlists::TrackRemoveParams::Track]) }
         attr_accessor :tracks
 
+        # 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 playlist's snapshot ID against which you want to make the changes. The API
         # will validate that the specified items exist and in the specified positions and
         # make the changes, even if more recent changes have been made to the playlist.
@@ -36,6 +47,7 @@ module Spotted
           params(
             tracks:
               T::Array[Spotted::Playlists::TrackRemoveParams::Track::OrHash],
+            published: T::Boolean,
             snapshot_id: String,
             request_options: Spotted::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -47,6 +59,12 @@ module Spotted
           # `{ "tracks": [{ "uri": "spotify:track:4iV5W9uYEdYUVa79Axb7Rh" },{ "uri": "spotify:track:1301WleyT98MSxVHPZCA6M" }] }`.
           # A maximum of 100 objects can be sent at once.
           tracks:,
+          # 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 playlist's snapshot ID against which you want to make the changes. The API
           # will validate that the specified items exist and in the specified positions and
           # make the changes, even if more recent changes have been made to the playlist.
@@ -59,6 +77,7 @@ module Spotted
           override.returns(
             {
               tracks: T::Array[Spotted::Playlists::TrackRemoveParams::Track],
+              published: T::Boolean,
               snapshot_id: String,
               request_options: Spotted::RequestOptions
             }

data/rbi/spotted/models/playlists/track_update_params.rbi

@@ -27,6 +27,17 @@ module Spotted
         sig { params(insert_before: Integer).void }
         attr_writer :insert_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 amount of items to be reordered. Defaults to 1 if not set.<br/>The range of
         # items to be reordered begins from the _range_start_ position, and includes the
         # _range_length_ subsequent items.<br/>Example:<br/>To move the items at index
@@ -61,6 +72,7 @@ module Spotted
         sig do
           params(
             insert_before: Integer,
+            published: T::Boolean,
             range_length: Integer,
             range_start: Integer,
             snapshot_id: String,
@@ -76,6 +88,12 @@ module Spotted
           # to 10.<br/>To reorder the last item in a playlist with 10 items to the start of
           # the playlist, set _range_start_ to 9, and _insert_before_ to 0.
           insert_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,
           # The amount of items to be reordered. Defaults to 1 if not set.<br/>The range of
           # items to be reordered begins from the _range_start_ position, and includes the
           # _range_length_ subsequent items.<br/>Example:<br/>To move the items at index
@@ -95,6 +113,7 @@ module Spotted
           override.returns(
             {
               insert_before: Integer,
+              published: T::Boolean,
               range_length: Integer,
               range_start: Integer,
               snapshot_id: String,

data/rbi/spotted/models/recommendation_get_response.rbi

@@ -21,18 +21,36 @@ module Spotted
       sig { returns(T::Array[Spotted::TrackObject]) }
       attr_accessor :tracks
 
+      # 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(
           seeds:
             T::Array[Spotted::Models::RecommendationGetResponse::Seed::OrHash],
-          tracks: T::Array[Spotted::TrackObject::OrHash]
+          tracks: T::Array[Spotted::TrackObject::OrHash],
+          published: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
         # An array of recommendation seed objects.
         seeds:,
         # An array of track objects ordered according to the parameters supplied.
-        tracks:
+        tracks:,
+        # 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
 
@@ -40,7 +58,8 @@ module Spotted
         override.returns(
           {
             seeds: T::Array[Spotted::Models::RecommendationGetResponse::Seed],
-            tracks: T::Array[Spotted::TrackObject]
+            tracks: T::Array[Spotted::TrackObject],
+            published: T::Boolean
           }
         )
       end
@@ -95,6 +114,17 @@ module Spotted
         sig { params(initial_pool_size: Integer).void }
         attr_writer :initial_pool_size
 
+        # 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 entity type of this seed. One of `artist`, `track` or `genre`.
         sig { returns(T.nilable(String)) }
         attr_reader :type
@@ -109,6 +139,7 @@ module Spotted
             after_relinking_size: Integer,
             href: String,
             initial_pool_size: Integer,
+            published: T::Boolean,
             type: String
           ).returns(T.attached_class)
         end
@@ -127,6 +158,12 @@ module Spotted
           href: nil,
           # The number of recommended tracks available for this seed.
           initial_pool_size: 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 entity type of this seed. One of `artist`, `track` or `genre`.
           type: nil
         )
@@ -140,6 +177,7 @@ module Spotted
               after_relinking_size: Integer,
               href: String,
               initial_pool_size: Integer,
+              published: T::Boolean,
               type: String
             }
           )

data/rbi/spotted/models/resume_point_object.rbi

@@ -15,6 +15,17 @@ module Spotted
       sig { params(fully_played: T::Boolean).void }
       attr_writer :fully_played
 
+      # 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 most recent position in the episode in milliseconds.
       sig { returns(T.nilable(Integer)) }
       attr_reader :resume_position_ms
@@ -23,13 +34,21 @@ module Spotted
       attr_writer :resume_position_ms
 
       sig do
-        params(fully_played: T::Boolean, resume_position_ms: Integer).returns(
-          T.attached_class
-        )
+        params(
+          fully_played: T::Boolean,
+          published: T::Boolean,
+          resume_position_ms: Integer
+        ).returns(T.attached_class)
       end
       def self.new(
         # Whether or not the episode has been fully played by the user.
         fully_played: 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 user's most recent position in the episode in milliseconds.
         resume_position_ms: nil
       )
@@ -37,7 +56,11 @@ module Spotted
 
       sig do
         override.returns(
-          { fully_played: T::Boolean, resume_position_ms: Integer }
+          {
+            fully_played: T::Boolean,
+            published: T::Boolean,
+            resume_position_ms: Integer
+          }
         )
       end
       def to_hash

data/rbi/spotted/models/search_query_response.rbi

@@ -167,6 +167,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,
@@ -178,7 +189,8 @@ module Spotted
             items:
               T::Array[
                 Spotted::Models::SearchQueryResponse::Albums::Item::OrHash
-              ]
+              ],
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -194,7 +206,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
 
@@ -208,7 +226,8 @@ module Spotted
               previous: T.nilable(String),
               total: Integer,
               items:
-                T::Array[Spotted::Models::SearchQueryResponse::Albums::Item]
+                T::Array[Spotted::Models::SearchQueryResponse::Albums::Item],
+              published: T::Boolean
             }
           )
         end
@@ -294,6 +313,17 @@ module Spotted
           sig { returns(String) }
           attr_accessor :uri
 
+          # 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
+
           # Included in the response when a content restriction is applied.
           sig { returns(T.nilable(Spotted::AlbumRestrictionObject)) }
           attr_reader :restrictions
@@ -319,6 +349,7 @@ module Spotted
                 Spotted::Models::SearchQueryResponse::Albums::Item::ReleaseDatePrecision::OrSymbol,
               total_tracks: Integer,
               uri: String,
+              published: T::Boolean,
               restrictions: Spotted::AlbumRestrictionObject::OrHash,
               type: Symbol
             ).returns(T.attached_class)
@@ -355,6 +386,12 @@ module Spotted
             # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
             # album.
             uri:,
+            # 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,
             # Included in the response when a content restriction is applied.
             restrictions: nil,
             # The object type.
@@ -380,6 +417,7 @@ module Spotted
                 total_tracks: Integer,
                 type: Symbol,
                 uri: String,
+                published: T::Boolean,
                 restrictions: Spotted::AlbumRestrictionObject
               }
             )
@@ -508,6 +546,17 @@ module Spotted
         sig { params(items: T::Array[Spotted::ArtistObject::OrHash]).void }
         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,
@@ -516,7 +565,8 @@ module Spotted
             offset: Integer,
             previous: T.nilable(String),
             total: Integer,
-            items: T::Array[Spotted::ArtistObject::OrHash]
+            items: T::Array[Spotted::ArtistObject::OrHash],
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -532,7 +582,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
 
@@ -545,7 +601,8 @@ module Spotted
               offset: Integer,
               previous: T.nilable(String),
               total: Integer,
-              items: T::Array[Spotted::ArtistObject]
+              items: T::Array[Spotted::ArtistObject],
+              published: T::Boolean
             }
           )
         end
@@ -592,6 +649,17 @@ module Spotted
         sig { params(items: T::Array[Spotted::AudiobookBase::OrHash]).void }
         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,
@@ -600,7 +668,8 @@ module Spotted
             offset: Integer,
             previous: T.nilable(String),
             total: Integer,
-            items: T::Array[Spotted::AudiobookBase::OrHash]
+            items: T::Array[Spotted::AudiobookBase::OrHash],
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -616,7 +685,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
 
@@ -629,7 +704,8 @@ module Spotted
               offset: Integer,
               previous: T.nilable(String),
               total: Integer,
-              items: T::Array[Spotted::AudiobookBase]
+              items: T::Array[Spotted::AudiobookBase],
+              published: T::Boolean
             }
           )
         end
@@ -678,6 +754,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,
@@ -686,7 +773,8 @@ module Spotted
             offset: Integer,
             previous: T.nilable(String),
             total: Integer,
-            items: T::Array[Spotted::SimplifiedEpisodeObject::OrHash]
+            items: T::Array[Spotted::SimplifiedEpisodeObject::OrHash],
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -702,7 +790,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
 
@@ -715,7 +809,8 @@ module Spotted
               offset: Integer,
               previous: T.nilable(String),
               total: Integer,
-              items: T::Array[Spotted::SimplifiedEpisodeObject]
+              items: T::Array[Spotted::SimplifiedEpisodeObject],
+              published: T::Boolean
             }
           )
         end
@@ -762,6 +857,17 @@ module Spotted
         sig { params(items: T::Array[Spotted::ShowBase::OrHash]).void }
         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,
@@ -770,7 +876,8 @@ module Spotted
             offset: Integer,
             previous: T.nilable(String),
             total: Integer,
-            items: T::Array[Spotted::ShowBase::OrHash]
+            items: T::Array[Spotted::ShowBase::OrHash],
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -786,7 +893,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
 
@@ -799,7 +912,8 @@ module Spotted
               offset: Integer,
               previous: T.nilable(String),
               total: Integer,
-              items: T::Array[Spotted::ShowBase]
+              items: T::Array[Spotted::ShowBase],
+              published: T::Boolean
             }
           )
         end
@@ -846,6 +960,17 @@ module Spotted
         sig { params(items: T::Array[Spotted::TrackObject::OrHash]).void }
         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,
@@ -854,7 +979,8 @@ module Spotted
             offset: Integer,
             previous: T.nilable(String),
             total: Integer,
-            items: T::Array[Spotted::TrackObject::OrHash]
+            items: T::Array[Spotted::TrackObject::OrHash],
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -870,7 +996,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
 
@@ -883,7 +1015,8 @@ module Spotted
               offset: Integer,
               previous: T.nilable(String),
               total: Integer,
-              items: T::Array[Spotted::TrackObject]
+              items: T::Array[Spotted::TrackObject],
+              published: T::Boolean
             }
           )
         end

data/rbi/spotted/models/show_base.rbi

@@ -83,6 +83,17 @@ module Spotted
       sig { returns(String) }
       attr_accessor :uri
 
+      # 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(
           id: String,
@@ -101,6 +112,7 @@ module Spotted
           publisher: String,
           total_episodes: Integer,
           uri: String,
+          published: T::Boolean,
           type: Symbol
         ).returns(T.attached_class)
       end
@@ -143,6 +155,12 @@ module Spotted
         # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
         # show.
         uri:,
+        # 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.
         type: :show
       )
@@ -167,7 +185,8 @@ module Spotted
             publisher: String,
             total_episodes: Integer,
             type: Symbol,
-            uri: String
+            uri: String,
+            published: T::Boolean
           }
         )
       end