runapi-suno 0.2.6 → 0.2.8

data/lib/runapi/suno/resources/add_instrumental.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Generates and adds an instrumental backing track to uploaded audio.
       class AddInstrumental
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/add_vocals.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Generates and adds vocals to an uploaded instrumental track.
       class AddVocals
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/boost_style.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Generates style/genre tags from a text description for use in style fields. Synchronous (run only).
       class BoostStyle
         include RunApi::Core::ResourceHelpers
 
@@ -13,10 +14,10 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
+        def run(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         private

data/lib/runapi/suno/resources/check_voice.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Step 4 of voice cloning: checks whether a custom voice is ready for use. Synchronous (run only).
       class CheckVoice
         include RunApi::Core::ResourceHelpers
 
@@ -13,10 +14,10 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
+        def run(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         private

data/lib/runapi/suno/resources/convert_audio.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Converts a generated track to WAV format.
       class ConvertAudio
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/cover_audio.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Re-records vocals over an uploaded audio file with a new style or voice.
       class CoverAudio
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/create_mashup.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Blends two audio tracks into a single new composition.
       class CreateMashup
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/extend_music.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Continues an existing track from a specified timestamp, inheriting or overriding its settings.
       class ExtendMusic
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/generate_artwork.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Creates cover artwork for an existing music task.
       class GenerateArtwork
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/generate_lyrics.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Produces AI-generated lyrics from a text prompt.
       class GenerateLyrics
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/generate_midi.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Extracts per-instrument MIDI note data from a generated track.
       class GenerateMidi
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/generate_persona.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Creates a reusable style or voice persona from an existing track's vocals. Synchronous (run only).
       class GeneratePersona
         include RunApi::Core::ResourceHelpers
 
@@ -13,10 +14,10 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
+        def run(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         private

data/lib/runapi/suno/resources/generate_voice.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Step 3 of voice cloning: trains a custom voice from the user's recording of the validation phrase.
       class GenerateVoice
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/get_timestamped_lyrics.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Retrieves word-level timing alignment for a track. Synchronous (run only, no create/get polling).
       class GetTimestampedLyrics
         include RunApi::Core::ResourceHelpers
 
@@ -13,10 +14,10 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
+        def run(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         private

data/lib/runapi/suno/resources/regenerate_validation_phrase.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Step 2 (optional) of voice cloning: requests a new, easier validation phrase.
       class RegenerateValidationPhrase
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/replace_section.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Re-generates a time range within an existing track with new lyrics and style.
       class ReplaceSection
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/separate_audio_stems.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Splits a track into individual instrument stems (vocals, drums, bass, guitar, etc.).
       class SeparateAudioStems
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/text_to_music.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Generates songs from a text prompt with configurable vocal mode, style, and persona.
       class TextToMusic
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/text_to_sound.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Generates sound effects (not music) from a text description with optional looping and BPM control.
       class TextToSound
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/suno/resources/visualize_music.rb

@@ -3,6 +3,7 @@
 module RunApi
   module Suno
     module Resources
+      # Generates a music visualization video from an existing track.
       class VisualizeMusic
         include RunApi::Core::ResourceHelpers
 
@@ -14,19 +15,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private