openai 0.78.0 → 0.79.0

data/lib/openai/resources/images.rb

@@ -9,6 +9,10 @@ module OpenAI
       #
       # Creates a variation of a given image. This endpoint only supports `dall-e-2`.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload create_variation(image:, model: nil, n: nil, response_format: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart] The image to use as the basis for the variation(s). Must be a valid PNG file, le
@@ -50,6 +54,10 @@ module OpenAI
       # prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`,
       # `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload edit(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>] The image(s) to edit. Must be a supported image file or an array of images.
@@ -111,6 +119,10 @@ module OpenAI
       # prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`,
       # `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload edit_stream_raw(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>] The image(s) to edit. Must be a supported image file or an array of images.

data/lib/openai/resources/responses.rb

@@ -407,12 +407,12 @@ module OpenAI
       # @see OpenAI::Models::Responses::ResponseRetrieveParams
       def retrieve_streaming(response_id, params = {})
         parsed, options = OpenAI::Responses::ResponseRetrieveParams.dump_request(params)
-        query = OpenAI::Internal::Util.encode_query_params(parsed)
         unless parsed.fetch(:stream, true)
           message = "Please use `#retrieve` for the non-streaming use case."
           raise ArgumentError.new(message)
         end
         parsed.store(:stream, true)
+        query = OpenAI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["responses/%1$s", response_id],
@@ -662,7 +662,8 @@ module OpenAI
               tool_models.store(name, params)
               tool[:function][:parameters] = params.to_json_schema
               tool
-            in {type: _, function: Hash => func} if func[:parameters].is_a?(Class) && func[:parameters] < OpenAI::Internal::Type::BaseModel
+            in {type: _, function: Hash => func} if func[:parameters].is_a?(Class) &&
+              func[:parameters] < OpenAI::Internal::Type::BaseModel
               params = func[:parameters]
               name = func[:name] || params.name.split("::").last
               tool_models.store(name, params)

data/lib/openai/resources/skills/versions.rb

@@ -9,6 +9,10 @@ module OpenAI
 
         # Create a new immutable skill version.
         #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
+        #
         # @overload create(skill_id, default: nil, files: nil, request_options: {})
         #
         # @param skill_id [String] The identifier of the skill to version.

data/lib/openai/resources/skills.rb

@@ -11,6 +11,10 @@ module OpenAI
 
       # Create a new skill.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload create(files: nil, request_options: {})
       #
       # @param files [Array<Pathname, StringIO, IO, String, OpenAI::FilePart>, Pathname, StringIO, IO, String, OpenAI::FilePart] Skill files to upload (directory upload) or a single zip file.

data/lib/openai/resources/uploads/parts.rb

@@ -20,6 +20,10 @@ module OpenAI
         # order of the Parts when you
         # [complete the Upload](https://platform.openai.com/docs/api-reference/uploads/complete).
         #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
+        #
         # @overload create(upload_id, data:, request_options: {})
         #
         # @param upload_id [String] The ID of the Upload.

data/lib/openai/resources/vector_stores/file_batches.rb

@@ -123,11 +123,11 @@ module OpenAI
         # @see OpenAI::Models::VectorStores::FileBatchListFilesParams
         def list_files(batch_id, params)
           parsed, options = OpenAI::VectorStores::FileBatchListFilesParams.dump_request(params)
-          query = OpenAI::Internal::Util.encode_query_params(parsed)
           vector_store_id =
             parsed.delete(:vector_store_id) do
               raise ArgumentError.new("missing required path argument #{_1}")
             end
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["vector_stores/%1$s/file_batches/%2$s/files", vector_store_id, batch_id],

data/lib/openai/resources/videos.rb

@@ -2,12 +2,20 @@
 
 module OpenAI
   module Resources
+    # @deprecated The Sora API is scheduled to permanently shut down on September
+    # 24, 2026.
     class Videos
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::VideoCreateParams} for more details.
       #
       # Create a new video generation job from a prompt and optional reference assets.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload create(prompt:, input_reference: nil, model: nil, seconds: nil, size: nil, request_options: {})
       #
       # @param prompt [String] Text prompt that describes the video to generate.
@@ -38,6 +46,8 @@ module OpenAI
         )
       end
 
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Fetch the latest metadata for a generated video.
       #
       # @overload retrieve(video_id, request_options: {})
@@ -59,6 +69,8 @@ module OpenAI
         )
       end
 
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::VideoListParams} for more details.
       #
@@ -91,6 +103,8 @@ module OpenAI
         )
       end
 
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Permanently delete a completed or failed video and its stored assets.
       #
       # @overload delete(video_id, request_options: {})
@@ -112,8 +126,14 @@ module OpenAI
         )
       end
 
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Create a character from an uploaded video.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload create_character(name:, video:, request_options: {})
       #
       # @param name [String] Display name for this API character.
@@ -138,6 +158,8 @@ module OpenAI
         )
       end
 
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Download the generated video bytes or a derived preview asset.
       #
       # Streams the rendered video content for the specified video job.
@@ -167,9 +189,15 @@ module OpenAI
         )
       end
 
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Create a new video generation job by editing a source video or existing
       # generated video.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload edit(prompt:, video:, request_options: {})
       #
       # @param prompt [String] Text prompt that describes how to edit the source video.
@@ -194,11 +222,17 @@ module OpenAI
         )
       end
 
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::VideoExtendParams} for more details.
       #
       # Create an extension of a completed video.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload extend_(prompt:, seconds:, video:, request_options: {})
       #
       # @param prompt [String] Updated text prompt that directs the extension generation.
@@ -225,6 +259,8 @@ module OpenAI
         )
       end
 
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Fetch a character.
       #
       # @overload get_character(character_id, request_options: {})
@@ -246,6 +282,8 @@ module OpenAI
         )
       end
 
+      # @deprecated The Sora API is scheduled to permanently shut down on September 24, 2026.
+      #
       # Create a remix of a completed video using a refreshed prompt.
       #
       # @overload remix(video_id, prompt:, request_options: {})

data/lib/openai/resources/webhooks.rb

@@ -37,16 +37,26 @@ module OpenAI
         webhook_secret = @client.webhook_secret || ENV["OPENAI_WEBHOOK_SECRET"],
         tolerance = 300
       )
-        if webhook_secret.nil?
+        if webhook_secret.nil? || webhook_secret.strip.empty?
           raise ArgumentError,
                 "The webhook secret must either be set using the env var, OPENAI_WEBHOOK_SECRET, " \
                 "or passed to this function"
         end
 
-        # Extract required headers
-        signature_header = headers["webhook-signature"] || headers[:webhook_signature]
-        timestamp_header = headers["webhook-timestamp"] || headers[:webhook_timestamp]
-        webhook_id = headers["webhook-id"] || headers[:webhook_id]
+        header_names = %w[webhook-signature webhook-timestamp webhook-id]
+        normalized_headers = {}
+        headers.each do |name, value|
+          name = name.to_s.downcase.delete_prefix("http_").tr("_", "-")
+          next unless header_names.include?(name)
+
+          if normalized_headers.key?(name) && normalized_headers[name] != value
+            raise ArgumentError, "Conflicting values for #{name} header"
+          end
+
+          normalized_headers[name] = value
+        end
+
+        signature_header, timestamp_header, webhook_id = normalized_headers.values_at(*header_names)
 
         if signature_header.nil?
           raise ArgumentError, "Missing required webhook-signature header"
@@ -90,11 +100,13 @@ module OpenAI
 
         # Decode the secret if it starts with whsec_
         decoded_secret = if webhook_secret.start_with?("whsec_")
-          Base64.decode64(webhook_secret[6..])
+          Base64.strict_decode64(webhook_secret[6..])
         else
           webhook_secret
         end
 
+        raise ArgumentError, "The webhook secret must not be empty" if decoded_secret.empty?
+
         # Create the signed payload: {webhook_id}.{timestamp}.{payload}
         signed_payload = "#{webhook_id}.#{timestamp_header}.#{payload}"
 

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.78.0"
+  VERSION = "0.79.0"
 end