runapi-topaz 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40f94d07e2d993a379822f44b3a4c56e630472b9ec8a0a882c38d746f223206f
-  data.tar.gz: f8649bed0ba63f962c14e335546b81dc2d6ec61304b51976309d5bd076e39f23
+  metadata.gz: 8bb62f2b5c763e463433c6a31953baaf2f0f6fe9d2586898149e759b2b7a4544
+  data.tar.gz: 2890b5d76de93833bb898c9d2ad25eee601dc3597db7d35e1f332f3d3499b199
 SHA512:
-  metadata.gz: 59b8eee6de311173b3cd3159918352d2a6ae98714e3ec99d730dfaad9d27e3be87ac185fd76a6a9f20e2cfcbf3fa04f4a86cd6001c5c44474ee997164f27b3fb
-  data.tar.gz: 196b238d9eb37a8aecc2574515778dd46469ad2239d9015731cb2599db57e9aadacabfaebedb5797a0930f1fca120d07ea4a352721b7896989ca30139e3401ac
+  metadata.gz: 52ede417926cb5fffe3af6af0dd5e5a9e00ccb2cbb73ca86be7b963a94ee1dd04c913b4c05817a0ab34c9eafcca34c90bf936fef8fa21ef8f575d3ed03abaf34
+  data.tar.gz: 4d0496f468fd8c1277420c461cb7856e61efe269dc17614836c25da379104f42e9574b4b04f8d69885e458956ab60b52e3d1febaf3e62bf22edddc40f3192bf9

data/README.md

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

data/lib/runapi/topaz/client.rb

@@ -2,14 +2,24 @@
 
 module RunApi
   module Topaz
-    class Client
-      attr_reader :upscale_image, :upscale_video
+    # Topaz AI upscaling client for increasing image and video resolution.
+    #
+    # @example
+    #   client = RunApi::Topaz::Client.new(api_key: "sk-...")
+    #   result = client.upscale_image.run(
+    #     model: "topaz-upscale-image",
+    #     source_image_url: "https://example.com/photo.jpg",
+    #     upscale_factor: 2
+    #   )
+    #   puts result.images.first.url
+    class Client < RunApi::Core::Client
+      # @return [Resources::UpscaleImage] AI-powered image upscaling (1x, 2x, 4x, 8x).
+      attr_reader :upscale_image
+      # @return [Resources::UpscaleVideo] AI-powered video upscaling (1x, 2x, 4x).
+      attr_reader :upscale_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
         @upscale_image = Resources::UpscaleImage.new(http)
         @upscale_video = Resources::UpscaleVideo.new(http)
       end

data/lib/runapi/topaz/resources/upscale_image.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Topaz
     module Resources
+      # AI-powered image upscaling resource.
+      # Supports upscale factors of 1x, 2x, 4x, and 8x.
       class UpscaleImage
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/topaz/resources/upscale_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Topaz
     module Resources
+      # AI-powered video upscaling resource.
+      # Supports upscale factors of 1x, 2x, and 4x.
       class UpscaleVideo
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/topaz/types.rb

@@ -2,20 +2,28 @@
 
 module RunApi
   module Topaz
+    # Type definitions and constants for the Topaz upscaling API.
     module Types
+      # Image upscaling model slug.
       UPSCALE_IMAGE_MODEL = "topaz-upscale-image"
+      # Video upscaling model slug.
       UPSCALE_VIDEO_MODEL = "topaz-upscale-video"
+      # Allowed image upscale factors. Higher factors produce larger output but take longer.
       UPSCALE_IMAGE_FACTORS = [1, 2, 4, 8].freeze
+      # Allowed video upscale factors. Max 4x (8x is not supported for video).
       UPSCALE_VIDEO_FACTORS = [1, 2, 4].freeze
 
+      # URL to an upscaled image.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # URL to an upscaled video.
       class Video < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Async image upscaling task result with lifecycle status.
       class UpscaleImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
@@ -23,6 +31,7 @@ module RunApi
         optional :error, String
       end
 
+      # Async video upscaling task result with lifecycle status.
       class UpscaleVideoResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
@@ -30,10 +39,14 @@ module RunApi
         optional :error, String
       end
 
+      # Narrowed response returned by +run+ once polling confirms completion.
+      # Images are guaranteed present.
       class CompletedUpscaleImageResponse < UpscaleImageResponse
         required :images, [-> { Image }]
       end
 
+      # Narrowed response returned by +run+ once polling confirms completion.
+      # Videos are guaranteed present.
       class CompletedUpscaleVideoResponse < UpscaleVideoResponse
         required :videos, [-> { Video }]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-topaz
 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 topaz api Ruby SDK is the language-specific package for Topaz on
   RunAPI. Use this topaz api package for image upscale, video upscale, restoration,
   and production cleanup flows when your application needs JSON request bodies, task