spotted 0.23.0 → 0.25.0

data/rbi/spotted/models/audio_analysis_retrieve_response.rbi

@@ -40,6 +40,17 @@ module Spotted
       end
       attr_writer :meta
 
+      # 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
+
       # Sections are defined by large variations in rhythm or timbre, e.g. chorus,
       # verse, bridge, guitar solo, etc. Each section contains its own descriptions of
       # tempo, key, mode, time_signature, and loudness.
@@ -109,6 +120,7 @@ module Spotted
           bars: T::Array[Spotted::TimeIntervalObject::OrHash],
           beats: T::Array[Spotted::TimeIntervalObject::OrHash],
           meta: Spotted::Models::AudioAnalysisRetrieveResponse::Meta::OrHash,
+          published: T::Boolean,
           sections:
             T::Array[
               Spotted::Models::AudioAnalysisRetrieveResponse::Section::OrHash
@@ -130,6 +142,12 @@ module Spotted
         # multiples of tatums.
         beats: nil,
         meta: 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,
         # Sections are defined by large variations in rhythm or timbre, e.g. chorus,
         # verse, bridge, guitar solo, etc. Each section contains its own descriptions of
         # tempo, key, mode, time_signature, and loudness.
@@ -149,6 +167,7 @@ module Spotted
             bars: T::Array[Spotted::TimeIntervalObject],
             beats: T::Array[Spotted::TimeIntervalObject],
             meta: Spotted::Models::AudioAnalysisRetrieveResponse::Meta,
+            published: T::Boolean,
             sections:
               T::Array[Spotted::Models::AudioAnalysisRetrieveResponse::Section],
             segments:
@@ -347,6 +366,17 @@ module Spotted
         sig { params(mode_confidence: Float).void }
         attr_writer :mode_confidence
 
+        # 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 starting point (in seconds) of the section.
         sig { returns(T.nilable(Float)) }
         attr_reader :start
@@ -399,6 +429,7 @@ module Spotted
             mode:
               Spotted::Models::AudioAnalysisRetrieveResponse::Section::Mode::OrFloat,
             mode_confidence: Float,
+            published: T::Boolean,
             start: Float,
             tempo: Float,
             tempo_confidence: Float,
@@ -430,6 +461,12 @@ module Spotted
           mode: nil,
           # The confidence, from 0.0 to 1.0, of the reliability of the `mode`.
           mode_confidence: 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 starting point (in seconds) of the section.
           start: nil,
           # The overall estimated tempo of the section in beats per minute (BPM). In musical
@@ -461,6 +498,7 @@ module Spotted
               mode:
                 Spotted::Models::AudioAnalysisRetrieveResponse::Section::Mode::TaggedFloat,
               mode_confidence: Float,
+              published: T::Boolean,
               start: Float,
               tempo: Float,
               tempo_confidence: Float,
@@ -594,6 +632,17 @@ module Spotted
         sig { params(pitches: T::Array[Float]).void }
         attr_writer :pitches
 
+        # 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 starting point (in seconds) of the segment.
         sig { returns(T.nilable(Float)) }
         attr_reader :start
@@ -635,6 +684,7 @@ module Spotted
             loudness_max_time: Float,
             loudness_start: Float,
             pitches: T::Array[Float],
+            published: T::Boolean,
             start: Float,
             timbre: T::Array[Float]
           ).returns(T.attached_class)
@@ -673,6 +723,12 @@ module Spotted
           # the 12 vector indices are a combination of low-power spectrum values at their
           # respective pitch frequencies. ![pitch vector](/assets/audio/Pitch_vector.png)
           pitches: 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 starting point (in seconds) of the segment.
           start: nil,
           # Timbre is the quality of a musical note or sound that distinguishes different
@@ -708,6 +764,7 @@ module Spotted
               loudness_max_time: Float,
               loudness_start: Float,
               pitches: T::Array[Float],
+              published: T::Boolean,
               start: Float,
               timbre: T::Array[Float]
             }

data/rbi/spotted/models/audio_feature_bulk_retrieve_response.rbi

@@ -152,6 +152,17 @@ module Spotted
         sig { params(mode: Integer).void }
         attr_writer :mode
 
+        # 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
+
         # Speechiness detects the presence of spoken words in a track. The more
         # exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
         # closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
@@ -238,6 +249,7 @@ module Spotted
             liveness: Float,
             loudness: Float,
             mode: Integer,
+            published: T::Boolean,
             speechiness: Float,
             tempo: Float,
             time_signature: Integer,
@@ -293,6 +305,12 @@ module Spotted
           # Mode indicates the modality (major or minor) of a track, the type of scale from
           # which its melodic content is derived. Major is represented by 1 and minor is 0.
           mode: 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,
           # Speechiness detects the presence of spoken words in a track. The more
           # exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
           # closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
@@ -337,6 +355,7 @@ module Spotted
               liveness: Float,
               loudness: Float,
               mode: Integer,
+              published: T::Boolean,
               speechiness: Float,
               tempo: Float,
               time_signature: Integer,

data/rbi/spotted/models/audio_feature_retrieve_response.rbi

@@ -110,6 +110,17 @@ module Spotted
       sig { params(mode: Integer).void }
       attr_writer :mode
 
+      # 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
+
       # Speechiness detects the presence of spoken words in a track. The more
       # exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
       # closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
@@ -195,6 +206,7 @@ module Spotted
           liveness: Float,
           loudness: Float,
           mode: Integer,
+          published: T::Boolean,
           speechiness: Float,
           tempo: Float,
           time_signature: Integer,
@@ -249,6 +261,12 @@ module Spotted
         # Mode indicates the modality (major or minor) of a track, the type of scale from
         # which its melodic content is derived. Major is represented by 1 and minor is 0.
         mode: 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,
         # Speechiness detects the presence of spoken words in a track. The more
         # exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
         # closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
@@ -293,6 +311,7 @@ module Spotted
             liveness: Float,
             loudness: Float,
             mode: Integer,
+            published: T::Boolean,
             speechiness: Float,
             tempo: Float,
             time_signature: Integer,

data/rbi/spotted/models/audiobook_base.rbi

@@ -97,6 +97,17 @@ module Spotted
       sig { params(edition: String).void }
       attr_writer :edition
 
+      # 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,
@@ -117,6 +128,7 @@ module Spotted
           total_chapters: Integer,
           uri: String,
           edition: String,
+          published: T::Boolean,
           type: Symbol
         ).returns(T.attached_class)
       end
@@ -164,6 +176,12 @@ module Spotted
         uri:,
         # The edition of the audiobook.
         edition: 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: :audiobook
       )
@@ -190,7 +208,8 @@ module Spotted
             total_chapters: Integer,
             type: Symbol,
             uri: String,
-            edition: String
+            edition: String,
+            published: T::Boolean
           }
         )
       end

data/rbi/spotted/models/audiobook_bulk_retrieve_response.rbi

@@ -133,6 +133,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(
@@ -142,7 +153,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(
@@ -158,7 +170,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
 
@@ -171,7 +189,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/audiobook_retrieve_response.rbi

@@ -82,6 +82,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(
@@ -91,7 +102,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(
@@ -107,7 +119,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
 
@@ -120,7 +138,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/author_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 author.
-        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/browse/category_get_playlists_response.rbi

@@ -25,22 +25,44 @@ module Spotted
         sig { params(playlists: Spotted::PagingPlaylistObject::OrHash).void }
         attr_writer :playlists
 
+        # 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(
             message: String,
-            playlists: Spotted::PagingPlaylistObject::OrHash
+            playlists: Spotted::PagingPlaylistObject::OrHash,
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
           # The localized message of a playlist.
           message: nil,
-          playlists: nil
+          playlists: 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(
-            { message: String, playlists: Spotted::PagingPlaylistObject }
+            {
+              message: String,
+              playlists: Spotted::PagingPlaylistObject,
+              published: T::Boolean
+            }
           )
         end
         def to_hash

data/rbi/spotted/models/browse/category_list_response.rbi

@@ -99,6 +99,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,
@@ -110,7 +121,8 @@ module Spotted
               items:
                 T::Array[
                   Spotted::Models::Browse::CategoryListResponse::Categories::Item::OrHash
-                ]
+                ],
+              published: T::Boolean
             ).returns(T.attached_class)
           end
           def self.new(
@@ -126,7 +138,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
 
@@ -142,7 +160,8 @@ module Spotted
                 items:
                   T::Array[
                     Spotted::Models::Browse::CategoryListResponse::Categories::Item
-                  ]
+                  ],
+                published: T::Boolean
               }
             )
           end
@@ -175,12 +194,24 @@ module Spotted
             sig { returns(String) }
             attr_accessor :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
+
             sig do
               params(
                 id: String,
                 href: String,
                 icons: T::Array[Spotted::ImageObject::OrHash],
-                name: String
+                name: String,
+                published: T::Boolean
               ).returns(T.attached_class)
             end
             def self.new(
@@ -192,7 +223,13 @@ module Spotted
               # The category icon, in various sizes.
               icons:,
               # The name of the category.
-              name:
+              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)
+              published: nil
             )
             end
 
@@ -202,7 +239,8 @@ module Spotted
                   id: String,
                   href: String,
                   icons: T::Array[Spotted::ImageObject],
-                  name: String
+                  name: String,
+                  published: T::Boolean
                 }
               )
             end

data/rbi/spotted/models/browse/category_retrieve_response.rbi

@@ -29,12 +29,24 @@ module Spotted
         sig { returns(String) }
         attr_accessor :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
+
         sig do
           params(
             id: String,
             href: String,
             icons: T::Array[Spotted::ImageObject::OrHash],
-            name: String
+            name: String,
+            published: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
@@ -46,7 +58,13 @@ module Spotted
           # The category icon, in various sizes.
           icons:,
           # The name of the category.
-          name:
+          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)
+          published: nil
         )
         end
 
@@ -56,7 +74,8 @@ module Spotted
               id: String,
               href: String,
               icons: T::Array[Spotted::ImageObject],
-              name: String
+              name: String,
+              published: T::Boolean
             }
           )
         end

data/rbi/spotted/models/browse_get_featured_playlists_response.rbi

@@ -24,22 +24,44 @@ module Spotted
       sig { params(playlists: Spotted::PagingPlaylistObject::OrHash).void }
       attr_writer :playlists
 
+      # 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(
           message: String,
-          playlists: Spotted::PagingPlaylistObject::OrHash
+          playlists: Spotted::PagingPlaylistObject::OrHash,
+          published: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
         # The localized message of a playlist.
         message: nil,
-        playlists: nil
+        playlists: 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(
-          { message: String, playlists: Spotted::PagingPlaylistObject }
+          {
+            message: String,
+            playlists: Spotted::PagingPlaylistObject,
+            published: T::Boolean
+          }
         )
       end
       def to_hash