runapi-z-image 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5897ea70dd32d8d473283b3fc553f9b0ef44b45b861548476fe0c291ba011f
-  data.tar.gz: 8f35b13c1a81f908672f11fdaf0ba5381f7a61635f8c2cf36e6a15337b5bf856
+  metadata.gz: e0cc4cee5277c6f3caf58569a36a33c9f3a697637917c9091f4f42a6eaf5ebf3
+  data.tar.gz: da3efb2dada6fed4c156cf49401d49daa1ffcdeaf7013a8082e9f5c2d5c310f4
 SHA512:
-  metadata.gz: 559123b0ae56392d7e330ba32292f0279f9b574e5623ed74ffa86502a7c59e0db683e98f814c84843f451abdd5753cce3b91699defd57f8df29a798870bb94cd
-  data.tar.gz: '09f5c253adb7fdcf239e6e7905cbc699172a7dc1d2e6f8653f794a1f023400920e87ce9b7f05bfa9681d6043c0c8baf9e4be6b2070c5e3b935bc15a4d428ed50'
+  metadata.gz: 75846ad36c5f89f307132964b79bea2b0a8fb05b1ee7774262263e8fc948e785f54af2da3ff9502e0f09c605de728cc7abdbe8339daf57386e3572297bfa5634
+  data.tar.gz: f5ac2d339056d52006b69cdc5871f0ba024a4e546c9b3db8b7359ca5fb14d5716d2b625d90f46ac28ef6706a92dc5452c45e49bc3d9d95b04c5830d261371c86

data/README.md

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

data/lib/runapi/z_image/client.rb

@@ -2,14 +2,22 @@
 
 module RunApi
   module ZImage
-    class Client
+    # Z-Image text-to-image generation client.
+    #
+    # @example
+    #   client = RunApi::ZImage::Client.new(api_key: "sk-...")
+    #   result = client.text_to_image.run(
+    #     model: "z-image",
+    #     prompt: "A serene Japanese garden at sunrise",
+    #     aspect_ratio: "16:9"
+    #   )
+    #   puts result.images.first.url
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Text-to-image generation with configurable aspect ratio and safety filtering.
       attr_reader :text_to_image
 
       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_image = Resources::TextToImage.new(http)
       end
     end

data/lib/runapi/z_image/resources/text_to_image.rb

@@ -3,6 +3,7 @@
 module RunApi
   module ZImage
     module Resources
+      # Generates images from text prompts with configurable aspect ratio and safety filtering.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/z_image/types.rb

@@ -2,14 +2,19 @@
 
 module RunApi
   module ZImage
+    # Type definitions and constants for the Z-Image text-to-image API.
     module Types
+      # Z-Image model slug.
       MODELS = %w[z-image].freeze
+      # Output aspect ratios controlling generated image dimensions.
       ASPECT_RATIOS = %w[1:1 4:3 3:4 16:9 9:16].freeze
 
+      # URL to a generated image.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Async text-to-image task result with lifecycle status.
       class TextToImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
@@ -17,6 +22,8 @@ module RunApi
         optional :error, String
       end
 
+      # Narrowed response returned by +run+ once polling confirms completion.
+      # Images are guaranteed present.
       class CompletedTextToImageResponse < TextToImageResponse
         required :images, [-> { Image }]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-z-image
 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 z-image api Ruby SDK is the language-specific package for Z-Image
   on RunAPI. Use this z-image api package for text-to-image, image editing, and creative
   production flows when your application needs JSON request bodies, task status lookup,