runapi-luma 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35d4110ccae524821e2f501565de79a887afd9e5074453b0c510c384039f94fc
-  data.tar.gz: c7255e052c18688fa8b82365b70b1699b7528d3c472bd0f0169d0522dea75430
+  metadata.gz: a534b8161b9606234d3c2c79dafaa70ea8d7108c766e3c2abc582d9dfe9efef9
+  data.tar.gz: 4b6e1751bb3952d519fe4be8f3c636753fe1fcd41f2892cfd7696156adea9aca
 SHA512:
-  metadata.gz: '0348b4a54c531c072eca71e4d94774d96adc3174647d53da27c1dd4b8000e96f5548370bad78320a9e9216a11d1fe1f721175468ea304e2155cf81fdb2f4ae59'
-  data.tar.gz: 57869ae8dd131e7fd59f21e29214bb1559ee8b593c60189a5fa37c77c3f7fbaedb77172188c442475b8ec780fb70f9a545a828b44fbdbb41a900b0f5a1be50df
+  metadata.gz: 8214de6e41dc2adde5aa44cfbdcc81b71834be141b85c8388de954b113512330281e83cb424e974700086fbcf6a879c44b1033326292066091d11f9dbf99cef2
+  data.tar.gz: 1b01d42f7c69fbeef2670fc76f591e4c459f6dccb658dc4669832ce7b84d0fa12b5877cb373540b38e8f2150804e75a269d8410e87281b1c555bd4ab2508530e

data/README.md

@@ -24,6 +24,8 @@ status = client.video_modifications.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::Luma` error classes when building video jobs, Rails workers, or scripts. The available resources include video modifications. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.

data/lib/runapi/luma/client.rb

@@ -2,14 +2,22 @@
 
 module RunApi
   module Luma
-    class Client
+    # Luma prompt-guided video modification API client.
+    # Applies visual edits to an existing video -- changing style, adjusting atmosphere,
+    # or adding effects -- while preserving the source motion.
+    #
+    # @example
+    #   client = RunApi::Luma::Client.new(api_key: "your-api-key")
+    #   result = client.modify_video.run(
+    #     prompt: "Add a dramatic sunset lighting effect",
+    #     source_video_url: "https://example.com/input.mp4"
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::ModifyVideo] Prompt-guided video editing that preserves source motion.
       attr_reader :modify_video
 
       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
         @modify_video = Resources::ModifyVideo.new(http)
       end
     end

data/lib/runapi/luma/resources/modify_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Luma
     module Resources
+      # Luma video modification resource.
+      # Apply prompt-guided visual edits to an existing video while preserving its motion.
       class ModifyVideo
         include RunApi::Core::ResourceHelpers
 
@@ -14,17 +16,29 @@ module RunApi
           @http = http
         end
 
+        # Modify a video and wait until complete.
+        #
+        # @param params [Hash] modification parameters
+        # @return [RunApi::Luma::Types::CompletedModifyVideoResponse] completed task with videos
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Start a video modification task.
+        #
+        # @param params [Hash] modification parameters
+        # @return [RunApi::Luma::Types::ModifyVideoResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get video modification task status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::Luma::Types::ModifyVideoResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/luma/types.rb

@@ -2,22 +2,28 @@
 
 module RunApi
   module Luma
+    # Type definitions and constants for Luma video modification.
     module Types
+      # A video file with a download URL.
       class Video < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Base async task response with id and status tracking.
       class AsyncTaskResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
       end
 
+      # Task status response for a video modification operation.
+      # On completion, +videos+ contains the modified output and +sources+ contains the original input.
       class ModifyVideoResponse < AsyncTaskResponse
         optional :videos, [-> { Video }]
         optional :sources, [-> { Video }]
         optional :error, String
       end
 
+      # Completed video modification response with guaranteed output videos.
       class CompletedModifyVideoResponse < ModifyVideoResponse
         required :videos, [-> { Video }]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-luma
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
 description: The luma ai api Ruby SDK is the language-specific package for Luma on
   RunAPI. Use this luma ai api package for text-to-video, image-to-video, video editing,
   and animation flows when your application needs JSON request bodies, task status