spotted 0.23.0 → 0.25.0

data/lib/spotted/models/track_object.rb

@@ -120,6 +120,16 @@ module Spotted
       #   @return [String, nil]
       optional :preview_url, String, nil?: true
 
+      # @!attribute published
+      #   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)
+      #
+      #   @return [Boolean, nil]
+      optional :published, Spotted::Internal::Type::Boolean
+
       # @!attribute restrictions
       #   Included in the response when a content restriction is applied.
       #
@@ -146,7 +156,7 @@ module Spotted
       #   @return [String, nil]
       optional :uri, String
 
-      # @!method initialize(id: nil, album: nil, artists: nil, available_markets: nil, disc_number: nil, duration_ms: nil, explicit: nil, external_ids: nil, external_urls: nil, href: nil, is_local: nil, is_playable: nil, linked_from: nil, name: nil, popularity: nil, preview_url: nil, restrictions: nil, track_number: nil, type: nil, uri: nil)
+      # @!method initialize(id: nil, album: nil, artists: nil, available_markets: nil, disc_number: nil, duration_ms: nil, explicit: nil, external_ids: nil, external_urls: nil, href: nil, is_local: nil, is_playable: nil, linked_from: nil, name: nil, popularity: nil, preview_url: nil, published: nil, restrictions: nil, track_number: nil, type: nil, uri: nil)
       #   Some parameter documentations has been truncated, see
       #   {Spotted::Models::TrackObject} for more details.
       #
@@ -182,6 +192,8 @@ module Spotted
       #
       #   @param preview_url [String, nil] A link to a 30 second preview (MP3 format) of the track. Can be `null`
       #
+      #   @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
+      #
       #   @param restrictions [Spotted::Models::TrackRestrictionObject] Included in the response when a content restriction is applied.
       #
       #   @param track_number [Integer] The number of the track. If an album has several discs, the track number is the
@@ -277,13 +289,23 @@ module Spotted
         #   @return [String]
         required :uri, String
 
+        # @!attribute published
+        #   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)
+        #
+        #   @return [Boolean, nil]
+        optional :published, Spotted::Internal::Type::Boolean
+
         # @!attribute restrictions
         #   Included in the response when a content restriction is applied.
         #
         #   @return [Spotted::Models::AlbumRestrictionObject, nil]
         optional :restrictions, -> { Spotted::AlbumRestrictionObject }
 
-        # @!method initialize(id:, album_type:, artists:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, uri:, restrictions: nil, type: :album)
+        # @!method initialize(id:, album_type:, artists:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, uri:, published: nil, restrictions: nil, type: :album)
         #   Some parameter documentations has been truncated, see
         #   {Spotted::Models::TrackObject::Album} for more details.
         #
@@ -314,6 +336,8 @@ module Spotted
         #
         #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the albu
         #
+        #   @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
+        #
         #   @param restrictions [Spotted::Models::AlbumRestrictionObject] Included in the response when a content restriction is applied.
         #
         #   @param type [Symbol, :album] The object type.

data/lib/spotted/models/track_restriction_object.rb

@@ -3,6 +3,16 @@
 module Spotted
   module Models
     class TrackRestrictionObject < Spotted::Internal::Type::BaseModel
+      # @!attribute published
+      #   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)
+      #
+      #   @return [Boolean, nil]
+      optional :published, Spotted::Internal::Type::Boolean
+
       # @!attribute reason
       #   The reason for the restriction. Supported values:
       #
@@ -18,10 +28,12 @@ module Spotted
       #   @return [String, nil]
       optional :reason, String
 
-      # @!method initialize(reason: nil)
+      # @!method initialize(published: nil, reason: nil)
       #   Some parameter documentations has been truncated, see
       #   {Spotted::Models::TrackRestrictionObject} for more details.
       #
+      #   @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
+      #
       #   @param reason [String] The reason for the restriction. Supported values:
     end
   end

data/lib/spotted/models/user_retrieve_profile_response.rb

@@ -41,6 +41,16 @@ module Spotted
       #   @return [Array<Spotted::Models::ImageObject>, nil]
       optional :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
 
+      # @!attribute published
+      #   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)
+      #
+      #   @return [Boolean, nil]
+      optional :published, Spotted::Internal::Type::Boolean
+
       # @!attribute type
       #   The object type.
       #
@@ -54,7 +64,7 @@ module Spotted
       #   @return [String, nil]
       optional :uri, String
 
-      # @!method initialize(id: nil, display_name: nil, external_urls: nil, followers: nil, href: nil, images: nil, type: nil, uri: nil)
+      # @!method initialize(id: nil, display_name: nil, external_urls: nil, followers: nil, href: nil, images: nil, published: nil, type: nil, uri: nil)
       #   Some parameter documentations has been truncated, see
       #   {Spotted::Models::UserRetrieveProfileResponse} for more details.
       #
@@ -70,6 +80,8 @@ module Spotted
       #
       #   @param images [Array<Spotted::Models::ImageObject>] The user's profile image.
       #
+      #   @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
+      #
       #   @param type [Symbol, Spotted::Models::UserRetrieveProfileResponse::Type] The object type.
       #
       #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this use

data/lib/spotted/models/users/playlist_create_response.rb

@@ -65,14 +65,15 @@ module Spotted
         #   @return [Spotted::Models::Users::PlaylistCreateResponse::Owner, nil]
         optional :owner, -> { Spotted::Models::Users::PlaylistCreateResponse::Owner }
 
-        # @!attribute public
-        #   The playlist's public/private status (if it is added to the user's profile):
-        #   `true` the playlist is public, `false` the playlist is private, `null` the
-        #   playlist status is not relevant. For more about public/private status, see
+        # @!attribute published
+        #   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)
         #
         #   @return [Boolean, nil]
-        optional :public, Spotted::Internal::Type::Boolean
+        optional :published, Spotted::Internal::Type::Boolean
 
         # @!attribute snapshot_id
         #   The version identifier for the current playlist. Can be supplied in other
@@ -100,7 +101,7 @@ module Spotted
         #   @return [String, nil]
         optional :uri, String
 
-        # @!method initialize(id: nil, collaborative: nil, description: nil, external_urls: nil, followers: nil, href: nil, images: nil, name: nil, owner: nil, public: nil, snapshot_id: nil, tracks: nil, type: nil, uri: nil)
+        # @!method initialize(id: nil, collaborative: nil, description: nil, external_urls: nil, followers: nil, href: nil, images: nil, name: nil, owner: nil, published: nil, snapshot_id: nil, tracks: nil, type: nil, uri: nil)
         #   Some parameter documentations has been truncated, see
         #   {Spotted::Models::Users::PlaylistCreateResponse} for more details.
         #
@@ -123,7 +124,7 @@ module Spotted
         #
         #   @param owner [Spotted::Models::Users::PlaylistCreateResponse::Owner] The user who owns the playlist
         #
-        #   @param public [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
+        #   @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
         #
         #   @param snapshot_id [String] The version identifier for the current playlist. Can be supplied in other reques
         #
@@ -193,7 +194,17 @@ module Spotted
           #   @return [Array<Spotted::Models::PlaylistTrackObject>, nil]
           optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::PlaylistTrackObject] }
 
-          # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil)
+          # @!attribute published
+          #   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)
+          #
+          #   @return [Boolean, nil]
+          optional :published, Spotted::Internal::Type::Boolean
+
+          # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
           #   Some parameter documentations has been truncated, see
           #   {Spotted::Models::Users::PlaylistCreateResponse::Tracks} for more details.
           #
@@ -212,6 +223,8 @@ module Spotted
           #   @param total [Integer] The total number of items available to return.
           #
           #   @param items [Array<Spotted::Models::PlaylistTrackObject>]
+          #
+          #   @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
         end
       end
     end

data/lib/spotted/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotted
-  VERSION = "0.23.0"
+  VERSION = "0.25.0"
 end

data/rbi/spotted/models/album_bulk_retrieve_response.rbi

@@ -159,6 +159,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
@@ -205,6 +216,7 @@ module Spotted
             genres: T::Array[String],
             label: String,
             popularity: Integer,
+            published: T::Boolean,
             restrictions: Spotted::AlbumRestrictionObject::OrHash,
             tracks:
               Spotted::Models::AlbumBulkRetrieveResponse::Album::Tracks::OrHash,
@@ -254,6 +266,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.
@@ -286,6 +304,7 @@ module Spotted
               genres: T::Array[String],
               label: String,
               popularity: Integer,
+              published: T::Boolean,
               restrictions: Spotted::AlbumRestrictionObject,
               tracks: Spotted::Models::AlbumBulkRetrieveResponse::Album::Tracks
             }
@@ -415,6 +434,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(
@@ -424,7 +454,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(
@@ -440,7 +471,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
 
@@ -453,7 +490,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/album_restriction_object.rbi

@@ -8,6 +8,17 @@ module Spotted
           T.any(Spotted::AlbumRestrictionObject, Spotted::Internal::AnyHash)
         end
 
+      # 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 reason for the restriction. Albums may be restricted if the content is not
       # available in a given market, to the user's subscription type, or when the user's
       # account is set to not play explicit content. Additional reasons may be added in
@@ -26,10 +37,17 @@ module Spotted
 
       sig do
         params(
+          published: T::Boolean,
           reason: Spotted::AlbumRestrictionObject::Reason::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
+        # 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 reason for the restriction. Albums may be restricted if the content is not
         # available in a given market, to the user's subscription type, or when the user's
         # account is set to not play explicit content. Additional reasons may be added in
@@ -40,7 +58,10 @@ module Spotted
 
       sig do
         override.returns(
-          { reason: Spotted::AlbumRestrictionObject::Reason::TaggedSymbol }
+          {
+            published: T::Boolean,
+            reason: Spotted::AlbumRestrictionObject::Reason::TaggedSymbol
+          }
         )
       end
       def to_hash

data/rbi/spotted/models/album_retrieve_response.rbi

@@ -122,6 +122,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
@@ -161,6 +172,7 @@ module Spotted
           genres: T::Array[String],
           label: String,
           popularity: Integer,
+          published: T::Boolean,
           restrictions: Spotted::AlbumRestrictionObject::OrHash,
           tracks: Spotted::Models::AlbumRetrieveResponse::Tracks::OrHash,
           type: Symbol
@@ -209,6 +221,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.
@@ -241,6 +259,7 @@ module Spotted
             genres: T::Array[String],
             label: String,
             popularity: Integer,
+            published: T::Boolean,
             restrictions: Spotted::AlbumRestrictionObject,
             tracks: Spotted::Models::AlbumRetrieveResponse::Tracks
           }
@@ -367,6 +386,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(
@@ -376,7 +406,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(
@@ -392,7 +423,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
 
@@ -405,7 +442,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/artist_list_albums_response.rbi

@@ -89,6 +89,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
@@ -114,6 +125,7 @@ module Spotted
             Spotted::Models::ArtistListAlbumsResponse::ReleaseDatePrecision::OrSymbol,
           total_tracks: Integer,
           uri: String,
+          published: T::Boolean,
           restrictions: Spotted::AlbumRestrictionObject::OrHash,
           type: Symbol
         ).returns(T.attached_class)
@@ -152,6 +164,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.
@@ -179,6 +197,7 @@ module Spotted
             total_tracks: Integer,
             type: Symbol,
             uri: String,
+            published: T::Boolean,
             restrictions: Spotted::AlbumRestrictionObject
           }
         )

data/rbi/spotted/models/artist_object.rbi

@@ -68,6 +68,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
+
       # The object type.
       sig { returns(T.nilable(Spotted::ArtistObject::Type::TaggedSymbol)) }
       attr_reader :type
@@ -93,6 +104,7 @@ module Spotted
           images: T::Array[Spotted::ImageObject::OrHash],
           name: String,
           popularity: Integer,
+          published: T::Boolean,
           type: Spotted::ArtistObject::Type::OrSymbol,
           uri: String
         ).returns(T.attached_class)
@@ -118,6 +130,12 @@ module Spotted
         # being the most popular. The artist's popularity is calculated from the
         # popularity of all the artist's tracks.
         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,
         # The object type.
         type: nil,
         # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -137,6 +155,7 @@ module Spotted
             images: T::Array[Spotted::ImageObject],
             name: String,
             popularity: Integer,
+            published: T::Boolean,
             type: Spotted::ArtistObject::Type::TaggedSymbol,
             uri: String
           }