runapi-suno 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f676e53a763fe863f61cd2fbd16f0702c93f2d189f7369d1471e819dd01bfa79
-  data.tar.gz: 76e18fcc6c46fe6b0f97be04949db28868d9f4ea3bfe7efcf5aa5296ca9a6ff7
+  metadata.gz: 124108c4cd23a7de517f3ab0f0eac3b38b898c43774965bb4819c946e8f62a28
+  data.tar.gz: 35d6431cf52fb7159d390a45adfd5899220b72862e5282e2f56053ad64870997
 SHA512:
-  metadata.gz: 83832d65fe97b8d8bfa5eae30c1f095fe8ea13368f06242588d89e67aa31013e2cd9ef3b5b7ba14e760430b13d76cc83a942dafd7878b654f58d6a3ff0736b5a
-  data.tar.gz: 5973d5187e4c761c056f1cde61a2e68f6fab5be8d42988e66194989eaddaafda9e77b6b481d89ee5eea5d84997f86def8a6c57ac8ceebd34bd570701dbcb1866
+  metadata.gz: 93841c24e1ba681727532961006a2ea959dece477c1b7419d09acfc322893e25eab178efe282bc1c250363c7e001fcd8af337ec0ce36b7a106be459b48c498bd
+  data.tar.gz: 1aeb7d43eea7c6d2aac1e08a28ac2cc6aacc6f82c6cd57929c240a4880f3ae4fd25cd2b87eef65dc51169949858c5696926b2d71d698db44952946e141ae4ac6

data/README.md

@@ -1,8 +1,8 @@
-# Suno AI API Ruby SDK for RunAPI
+# Suno API Ruby SDK for RunAPI
 
-The suno ai api Ruby SDK is the language-specific package for Suno on RunAPI. Use this suno ai api package for song generation, lyrics, vocal, extension, and audio transformation flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+The Suno Ruby SDK is the language-specific package for Suno on RunAPI. Use this package for song generation, lyrics, vocals, extension, and audio transformation workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Ruby.
 
-This suno ai api README is the Ruby package guide inside the public `suno-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/suno; for API reference, use https://runapi.ai/docs#suno; for SDK docs, use https://runapi.ai/docs#sdk-suno.
+This README is the Ruby package guide inside the public `suno-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/suno; for API reference, use https://runapi.ai/docs#suno; for SDK docs, use https://runapi.ai/docs#sdk-suno.
 
 ## Install
 
@@ -13,27 +13,29 @@ gem install runapi-suno
 ## Quick start
 
 ```ruby
-require "runapi-suno"
+require "runapi/suno"
 
 client = RunApi::Suno::Client.new
-task = client.generations.create(
+task = client.text_to_music.create(
   # Pass the Suno JSON request body from https://runapi.ai/docs#suno.
 )
-status = client.generations.get(task.id)
+status = client.text_to_music.get(task.id)
 ```
 
 Use `create` when you want to submit a task and return quickly, `get` when you need the latest task state, and `run` when a script should create and poll until completion. In web request handlers, prefer `create` plus webhook or later `get` polling so a worker is not held open.
 
+RunAPI-generated file URLs are temporary. Download and store generated images, videos, audio, or other files in your own durable storage within 7 days; do not treat returned URLs as long-term assets.
+
 ## Language notes
 
-Use Ruby keyword arguments and the `RunApi::Suno` error classes when building music jobs, Rails workers, or scripts. The available resources include generations, extensions, upload and extensions, covers, upload and covers, instrumentals, vocals, vocal removals, midi, wav conversions, music videos, lyrics, timestamped lyrics, section replacements, mashups, sounds, personas, and styles. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
+Use Ruby keyword arguments and the `RunApi::Suno` error classes when building music jobs, Rails workers, or scripts. The available resources are `text_to_music`, `extend_music`, `generate_artwork`, `cover_audio`, `add_instrumental`, `add_vocals`, `separate_audio_stems`, `generate_midi`, `convert_audio`, `visualize_music`, `generate_lyrics`, `get_timestamped_lyrics`, `replace_section`, `create_mashup`, `text_to_sound`, `voice_to_validation_phrase`, `regenerate_validation_phrase`, `generate_voice`, `check_voice`, `generate_persona`, and `boost_style`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 
 - Model page: https://runapi.ai/models/suno
 - SDK docs: https://runapi.ai/docs#sdk-suno
 - Product docs: https://runapi.ai/docs#suno
-- Pricing and rate limits: https://runapi.ai/models/suno/v3.5
+- Pricing and rate limits: https://runapi.ai/models/suno/v4
 - Provider comparison: https://runapi.ai/providers/suno
 - Full catalog: https://runapi.ai/models
 - Repository: https://github.com/runapi-ai/suno-sdk

data/lib/runapi/suno/client.rb

@@ -2,19 +2,61 @@
 
 module RunApi
   module Suno
-    class Client
-      attr_reader :text_to_music, :extend_music, :generate_artwork, :cover_audio,
-        :add_instrumental, :add_vocals, :separate_audio_stems, :generate_midi,
-        :convert_audio, :visualize_music, :generate_lyrics, :get_timestamped_lyrics,
-        :replace_section, :create_mashup, :text_to_sound, :voice_to_validation_phrase,
-        :regenerate_validation_phrase, :generate_voice, :check_voice, :generate_persona,
-        :boost_style
+    # Suno music platform client covering song generation, extension, covers, stems,
+    # MIDI, lyrics, mashups, sound effects, visualization, personas, and voice cloning.
+    #
+    # @example Generate a song from a text prompt
+    #   client = RunApi::Suno::Client.new(api_key: "sk-your-api-key")
+    #   result = client.text_to_music.run(
+    #     prompt: "A chill lo-fi beat with soft vocals",
+    #     model: "suno-v4.5-plus"
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToMusic] generates songs from a text prompt with configurable vocal mode, style, and persona
+      attr_reader :text_to_music
+      # @return [Resources::ExtendMusic] continues an existing track from a specified timestamp
+      attr_reader :extend_music
+      # @return [Resources::GenerateArtwork] creates cover artwork for an existing music task
+      attr_reader :generate_artwork
+      # @return [Resources::CoverAudio] re-records vocals over an uploaded audio file with a new style or voice
+      attr_reader :cover_audio
+      # @return [Resources::AddInstrumental] generates and adds an instrumental backing track to uploaded audio
+      attr_reader :add_instrumental
+      # @return [Resources::AddVocals] generates and adds vocals to an uploaded instrumental track
+      attr_reader :add_vocals
+      # @return [Resources::SeparateAudioStems] splits a track into individual instrument stems
+      attr_reader :separate_audio_stems
+      # @return [Resources::GenerateMidi] extracts per-instrument MIDI note data from a generated track
+      attr_reader :generate_midi
+      # @return [Resources::ConvertAudio] converts a generated track to WAV format
+      attr_reader :convert_audio
+      # @return [Resources::VisualizeMusic] generates a music visualization video from an existing track
+      attr_reader :visualize_music
+      # @return [Resources::GenerateLyrics] produces AI-generated lyrics from a text prompt
+      attr_reader :generate_lyrics
+      # @return [Resources::GetTimestampedLyrics] retrieves word-level timing alignment for a track (synchronous)
+      attr_reader :get_timestamped_lyrics
+      # @return [Resources::ReplaceSection] re-generates a time range within an existing track
+      attr_reader :replace_section
+      # @return [Resources::CreateMashup] blends two audio tracks into a single new composition
+      attr_reader :create_mashup
+      # @return [Resources::TextToSound] generates sound effects from a text description
+      attr_reader :text_to_sound
+      # @return [Resources::VoiceToValidationPhrase] step 1 of voice cloning: extracts a validation phrase
+      attr_reader :voice_to_validation_phrase
+      # @return [Resources::RegenerateValidationPhrase] step 2 (optional) of voice cloning: requests a new phrase
+      attr_reader :regenerate_validation_phrase
+      # @return [Resources::GenerateVoice] step 3 of voice cloning: trains a custom voice
+      attr_reader :generate_voice
+      # @return [Resources::CheckVoice] step 4 of voice cloning: checks whether a custom voice is ready (synchronous)
+      attr_reader :check_voice
+      # @return [Resources::GeneratePersona] creates a reusable style or voice persona from a track's vocals (synchronous)
+      attr_reader :generate_persona
+      # @return [Resources::BoostStyle] generates style/genre tags from a text description (synchronous)
+      attr_reader :boost_style
 
       def initialize(api_key: nil, **options)
-        @api_key = Core::Auth.resolve_api_key(api_key)
-
-        client_options = Core::ClientOptions.new(api_key: @api_key, **options)
-        http = client_options.http_client || Core::HttpClient.new(client_options)
+        super
 
         @text_to_music = Resources::TextToMusic.new(http)
         @extend_music = Resources::ExtendMusic.new(http)