runapi-gpt-4o-image 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2472cd75263166ddf4f6f6dcbe222c458bae3ccfc1acd0c106e9a2ce42241b1f
-  data.tar.gz: adaa442f974bf4101270ab1bbc057e95045594fdd0ec487d09edd60300729908
+  metadata.gz: fcb80b291743336ea11105108372ae8f5116811907b1a38fe6cc1e284ffc6b72
+  data.tar.gz: ef2b5b960ccb1d416975249bef34350f69e5940765b2f27130ad4d666bd94f4b
 SHA512:
-  metadata.gz: 6471cd4c36028b46fc900d4d3236a8cd1f45eb14ad12aa343c6b8114ab89865a371769c9b57b215f94c5afd93ec873dc35dd32bde83fedfb6703c794d6843beb
-  data.tar.gz: f5211a22702956fec1df59e764c4b3d7c45498b768f69673c08ce6c375f8eb36fe7e4534d01293aab469ee4c08e6ebab0838489c49631df4cbc13c72402699f4
+  metadata.gz: b2985e5a58b0a66ac18c6eae6e04d3ab31118338f1cffb8d7ded264e661a010b90c09a6a0a38da5f855bbea46e1f9eed58f4ae0502da1eab29e810f677d046fd
+  data.tar.gz: 56001d933cf766d533410f88edea4892fcdd7e75b1b5310699c94c7cf2ea7cd4abeffe20cbf6def298b4d3f721a782ca75d2cd8323c320b44caf57cd912f9c91

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::Gpt4oImage` 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/gpt_4o_image/client.rb

@@ -2,14 +2,32 @@
 
 module RunApi
   module Gpt4oImage
-    class Client
+    # GPT-4o Image generation and editing API client.
+    #
+    # Supports pure text-to-image generation, image editing with source images,
+    # and inpainting with an optional mask.
+    #
+    # @example
+    #   client = RunApi::Gpt4oImage::Client.new(api_key: "your-api-key")
+    #
+    #   # Pure generation
+    #   result = client.text_to_image.run(
+    #     model: "gpt-4o-image", prompt: "A mountain lake at dawn",
+    #     aspect_ratio: "3:2"
+    #   )
+    #
+    #   # Edit with source images
+    #   edited = client.text_to_image.run(
+    #     model: "gpt-4o-image", prompt: "Add a rainbow",
+    #     aspect_ratio: "3:2",
+    #     source_image_urls: ["https://example.com/photo.jpg"]
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Image generation and editing operations.
       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/gpt_4o_image/resources/text_to_image.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Gpt4oImage
     module Resources
+      # GPT-4o Image generation and editing resource.
+      # Generate images from text, edit with source images, or inpaint with a mask.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/gpt_4o_image/types.rb

@@ -2,15 +2,22 @@
 
 module RunApi
   module Gpt4oImage
+    # GPT-4o Image type constants and response models.
+    # Supports pure generation, editing with source images, and inpainting with a mask.
     module Types
       MODELS = %w[gpt-4o-image].freeze
+      # Required output aspect ratio.
       ASPECT_RATIOS = %w[1:1 3:2 2:3].freeze
+      # Batch sizes: 1, 2, or 4 images per request.
       OUTPUT_COUNTS = [1, 2, 4].freeze
 
+      # A generated image with its CDN URL.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Response for GPT-4o Image tasks. Progress contains an intermediate
+      # status string while the task is running.
       class TextToImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }

metadata

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