spotted 0.24.0 → 0.26.0

data/rbi/spotted/models/me/album_list_response.rbi

@@ -36,10 +36,22 @@ module Spotted
         end
         attr_writer :album
 
+        # 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,
-            album: Spotted::Models::Me::AlbumListResponse::Album::OrHash
+            album: Spotted::Models::Me::AlbumListResponse::Album::OrHash,
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -50,7 +62,13 @@ module Spotted
           # album object.
           added_at: nil,
           # Information about the album.
-          album: nil
+          album: 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
 
@@ -58,7 +76,8 @@ module Spotted
           override.returns(
             {
               added_at: Time,
-              album: Spotted::Models::Me::AlbumListResponse::Album
+              album: Spotted::Models::Me::AlbumListResponse::Album,
+              published: T::Boolean
             }
           )
         end
@@ -189,6 +208,17 @@ module Spotted
           sig { params(popularity: Integer).void }
           attr_writer :popularity
 
+          # 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
@@ -236,6 +266,7 @@ module Spotted
               genres: T::Array[String],
               label: String,
               popularity: Integer,
+              published: T::Boolean,
               restrictions: Spotted::AlbumRestrictionObject::OrHash,
               tracks:
                 Spotted::Models::Me::AlbumListResponse::Album::Tracks::OrHash,
@@ -285,6 +316,12 @@ module Spotted
             # The popularity of the album. The value will be between 0 and 100, with 100 being
             # the most popular.
             popularity: 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,
             # Included in the response when a content restriction is applied.
             restrictions: nil,
             # The tracks of the album.
@@ -317,6 +354,7 @@ module Spotted
                 genres: T::Array[String],
                 label: String,
                 popularity: Integer,
+                published: T::Boolean,
                 restrictions: Spotted::AlbumRestrictionObject,
                 tracks: Spotted::Models::Me::AlbumListResponse::Album::Tracks
               }
@@ -448,6 +486,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 album.
             sig do
               params(
@@ -457,7 +506,8 @@ module Spotted
                 offset: Integer,
                 previous: T.nilable(String),
                 total: Integer,
-                items: T::Array[Spotted::SimplifiedTrackObject::OrHash]
+                items: T::Array[Spotted::SimplifiedTrackObject::OrHash],
+                published: T::Boolean
               ).returns(T.attached_class)
             end
             def self.new(
@@ -473,7 +523,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
 
@@ -486,7 +542,8 @@ module Spotted
                   offset: Integer,
                   previous: T.nilable(String),
                   total: Integer,
-                  items: T::Array[Spotted::SimplifiedTrackObject]
+                  items: T::Array[Spotted::SimplifiedTrackObject],
+                  published: T::Boolean
                 }
               )
             end

data/rbi/spotted/models/me/album_remove_params.rbi

@@ -23,9 +23,21 @@ module Spotted
         sig { params(ids: T::Array[String]).void }
         attr_writer :ids
 
+        # 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(
             ids: T::Array[String],
+            published: T::Boolean,
             request_options: Spotted::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -36,13 +48,23 @@ module Spotted
           # 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._
           ids: 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,
           request_options: {}
         )
         end
 
         sig do
           override.returns(
-            { ids: T::Array[String], request_options: Spotted::RequestOptions }
+            {
+              ids: T::Array[String],
+              published: T::Boolean,
+              request_options: Spotted::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/spotted/models/me/album_save_params.rbi

@@ -23,9 +23,21 @@ module Spotted
         sig { params(ids: T::Array[String]).void }
         attr_writer :ids
 
+        # 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(
             ids: T::Array[String],
+            published: T::Boolean,
             request_options: Spotted::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -36,13 +48,23 @@ module Spotted
           # 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._
           ids: 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,
           request_options: {}
         )
         end
 
         sig do
           override.returns(
-            { ids: T::Array[String], request_options: Spotted::RequestOptions }
+            {
+              ids: T::Array[String],
+              published: T::Boolean,
+              request_options: Spotted::RequestOptions
+            }
           )
         end
         def to_hash

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/episode_remove_params.rbi

@@ -23,9 +23,21 @@ module Spotted
         sig { params(ids: T::Array[String]).void }
         attr_writer :ids
 
+        # 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(
             ids: T::Array[String],
+            published: T::Boolean,
             request_options: Spotted::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -36,13 +48,23 @@ module Spotted
           # is present in the query string, any IDs listed here in the body will be
           # ignored._
           ids: 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,
           request_options: {}
         )
         end
 
         sig do
           override.returns(
-            { ids: T::Array[String], request_options: Spotted::RequestOptions }
+            {
+              ids: T::Array[String],
+              published: T::Boolean,
+              request_options: Spotted::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/spotted/models/me/episode_save_params.rbi

@@ -20,9 +20,21 @@ module Spotted
         sig { returns(T::Array[String]) }
         attr_accessor :ids
 
+        # 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(
             ids: T::Array[String],
+            published: T::Boolean,
             request_options: Spotted::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -33,13 +45,23 @@ module Spotted
           # is present in the query string, any IDs listed here in the body will be
           # ignored._
           ids:,
+          # 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,
           request_options: {}
         )
         end
 
         sig do
           override.returns(
-            { ids: T::Array[String], request_options: Spotted::RequestOptions }
+            {
+              ids: T::Array[String],
+              published: T::Boolean,
+              request_options: Spotted::RequestOptions
+            }
           )
         end
         def to_hash

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