openai 0.36.0 → 0.36.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17baebbeaa4b29e9cd335b7cf1c0bef7a1e63832804c6f332e6cb508a4afd4d8
-  data.tar.gz: b9009868811efc0f57c9b33bbe51c031436e0ccebb2f944ad5d60259095a4099
+  metadata.gz: 6976ed8077092b131fe261b2a968357ee6cf0fa8006d34020c0cc966c0b2cf5f
+  data.tar.gz: c44842a11376b3da062d1c4948939e633e0de6fc2e979d0d502f9c39114bf6bf
 SHA512:
-  metadata.gz: 8b5ca35d9d0758f61af7f3b7966017ad6df9b3e0a582d2cbc3bc455ac3d651bed29554710a0c05e22a5ad481e0469cb8ab0448cbe1d356c52f07ee2bd0cfff65
-  data.tar.gz: 474f40178d640e14ddb001786670e0e063c45b7205895115a72a28075597ed798b52ab3cd1952296e847822f056433bb907d7022dae5c3780451c872709485f9
+  metadata.gz: 52619060805bb76964607ce798a943837eaa8ba9ba0a711133bc0ea6568af8c1c971a8ef67f5ecc4030fa67dbcc93266890f3a7e90b2955fbb29723af8d42271
+  data.tar.gz: 88344ac0e74606bf7e9898aafc630e048ae1c7536c37c216afc4b62c474b370a99e4cd702f483e46b793cc0335d6e2038e9e251f24eb19ebec4d849447ef819e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.36.1 (2025-11-17)
+
+Full Changelog: [v0.36.0...v0.36.1](https://github.com/openai/openai-ruby/compare/v0.36.0...v0.36.1)
+
+### Bug Fixes
+
+* **api:** align types of input items / output items for typescript ([b593643](https://github.com/openai/openai-ruby/commit/b5936439c6804161bc1a9a7900bdc33f09be1485))
+
 ## 0.36.0 (2025-11-13)
 
 Full Changelog: [v0.35.2...v0.36.0](https://github.com/openai/openai-ruby/compare/v0.35.2...v0.36.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.36.0"
+gem "openai", "~> 0.36.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/openai/models/responses/response_apply_patch_tool_call.rb

@@ -17,6 +17,13 @@ module OpenAI
         #   @return [String]
         required :call_id, String
 
+        # @!attribute operation
+        #   One of the create_file, delete_file, or update_file operations applied via
+        #   apply_patch.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::CreateFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile]
+        required :operation, union: -> { OpenAI::Responses::ResponseApplyPatchToolCall::Operation }
+
         # @!attribute status
         #   The status of the apply patch tool call. One of `in_progress` or `completed`.
         #
@@ -35,14 +42,7 @@ module OpenAI
         #   @return [String, nil]
         optional :created_by, String
 
-        # @!attribute operation
-        #   One of the create_file, delete_file, or update_file operations applied via
-        #   apply_patch.
-        #
-        #   @return [OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::CreateFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile, nil]
-        optional :operation, union: -> { OpenAI::Responses::ResponseApplyPatchToolCall::Operation }
-
-        # @!method initialize(id:, call_id:, status:, created_by: nil, operation: nil, type: :apply_patch_call)
+        # @!method initialize(id:, call_id:, operation:, status:, created_by: nil, type: :apply_patch_call)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseApplyPatchToolCall} for more details.
         #
@@ -52,27 +52,14 @@ module OpenAI
         #
         #   @param call_id [String] The unique ID of the apply patch tool call generated by the model.
         #
+        #   @param operation [OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::CreateFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile] One of the create_file, delete_file, or update_file operations applied via apply
+        #
         #   @param status [Symbol, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Status] The status of the apply patch tool call. One of `in_progress` or `completed`.
         #
         #   @param created_by [String] The ID of the entity that created this tool call.
         #
-        #   @param operation [OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::CreateFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile] One of the create_file, delete_file, or update_file operations applied via apply
-        #
         #   @param type [Symbol, :apply_patch_call] The type of the item. Always `apply_patch_call`.
 
-        # The status of the apply patch tool call. One of `in_progress` or `completed`.
-        #
-        # @see OpenAI::Models::Responses::ResponseApplyPatchToolCall#status
-        module Status
-          extend OpenAI::Internal::Type::Enum
-
-          IN_PROGRESS = :in_progress
-          COMPLETED = :completed
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
         # One of the create_file, delete_file, or update_file operations applied via
         # apply_patch.
         #
@@ -173,6 +160,19 @@ module OpenAI
           # @!method self.variants
           #   @return [Array(OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::CreateFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile, OpenAI::Models::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile)]
         end
+
+        # The status of the apply patch tool call. One of `in_progress` or `completed`.
+        #
+        # @see OpenAI::Models::Responses::ResponseApplyPatchToolCall#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          COMPLETED = :completed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/openai/models/responses/response_apply_patch_tool_call_output.rb

@@ -17,12 +17,6 @@ module OpenAI
         #   @return [String]
         required :call_id, String
 
-        # @!attribute output
-        #   Optional textual output returned by the apply patch tool.
-        #
-        #   @return [String, nil]
-        required :output, String, nil?: true
-
         # @!attribute status
         #   The status of the apply patch tool call output. One of `completed` or `failed`.
         #
@@ -41,7 +35,13 @@ module OpenAI
         #   @return [String, nil]
         optional :created_by, String
 
-        # @!method initialize(id:, call_id:, output:, status:, created_by: nil, type: :apply_patch_call_output)
+        # @!attribute output
+        #   Optional textual output returned by the apply patch tool.
+        #
+        #   @return [String, nil]
+        optional :output, String, nil?: true
+
+        # @!method initialize(id:, call_id:, status:, created_by: nil, output: nil, type: :apply_patch_call_output)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput} for more details.
         #
@@ -51,12 +51,12 @@ module OpenAI
         #
         #   @param call_id [String] The unique ID of the apply patch tool call generated by the model.
         #
-        #   @param output [String, nil] Optional textual output returned by the apply patch tool.
-        #
         #   @param status [Symbol, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::Status] The status of the apply patch tool call output. One of `completed` or `failed`.
         #
         #   @param created_by [String] The ID of the entity that created this tool call output.
         #
+        #   @param output [String, nil] Optional textual output returned by the apply patch tool.
+        #
         #   @param type [Symbol, :apply_patch_call_output] The type of the item. Always `apply_patch_call_output`.
 
         # The status of the apply patch tool call output. One of `completed` or `failed`.

data/lib/openai/models/responses/response_input_item.rb

@@ -956,7 +956,7 @@ module OpenAI
           #   or errors).
           #
           #   @return [String, nil]
-          optional :output, String
+          optional :output, String, nil?: true
 
           # @!method initialize(call_id:, status:, id: nil, output: nil, type: :apply_patch_call_output)
           #   Some parameter documentations has been truncated, see
@@ -971,7 +971,7 @@ module OpenAI
           #
           #   @param id [String, nil] The unique ID of the apply patch tool call output. Populated when this item is r
           #
-          #   @param output [String] Optional human-readable log text from the apply patch tool (e.g., patch results
+          #   @param output [String, nil] Optional human-readable log text from the apply patch tool (e.g., patch results
           #
           #   @param type [Symbol, :apply_patch_call_output] The type of the item. Always `apply_patch_call_output`.
 

data/lib/openai/version.rb

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

data/rbi/openai/models/responses/response_apply_patch_tool_call.rbi

@@ -21,6 +21,15 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :call_id
 
+        # One of the create_file, delete_file, or update_file operations applied via
+        # apply_patch.
+        sig do
+          returns(
+            OpenAI::Responses::ResponseApplyPatchToolCall::Operation::Variants
+          )
+        end
+        attr_accessor :operation
+
         # The status of the apply patch tool call. One of `in_progress` or `completed`.
         sig do
           returns(
@@ -40,43 +49,20 @@ module OpenAI
         sig { params(created_by: String).void }
         attr_writer :created_by
 
-        # One of the create_file, delete_file, or update_file operations applied via
-        # apply_patch.
-        sig do
-          returns(
-            T.nilable(
-              OpenAI::Responses::ResponseApplyPatchToolCall::Operation::Variants
-            )
-          )
-        end
-        attr_reader :operation
-
-        sig do
-          params(
-            operation:
-              T.any(
-                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::CreateFile::OrHash,
-                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile::OrHash,
-                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile::OrHash
-              )
-          ).void
-        end
-        attr_writer :operation
-
         # A tool call that applies file diffs by creating, deleting, or updating files.
         sig do
           params(
             id: String,
             call_id: String,
-            status:
-              OpenAI::Responses::ResponseApplyPatchToolCall::Status::OrSymbol,
-            created_by: String,
             operation:
               T.any(
                 OpenAI::Responses::ResponseApplyPatchToolCall::Operation::CreateFile::OrHash,
                 OpenAI::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile::OrHash,
                 OpenAI::Responses::ResponseApplyPatchToolCall::Operation::UpdateFile::OrHash
               ),
+            status:
+              OpenAI::Responses::ResponseApplyPatchToolCall::Status::OrSymbol,
+            created_by: String,
             type: Symbol
           ).returns(T.attached_class)
         end
@@ -86,13 +72,13 @@ module OpenAI
           id:,
           # The unique ID of the apply patch tool call generated by the model.
           call_id:,
+          # One of the create_file, delete_file, or update_file operations applied via
+          # apply_patch.
+          operation:,
           # The status of the apply patch tool call. One of `in_progress` or `completed`.
           status:,
           # The ID of the entity that created this tool call.
           created_by: nil,
-          # One of the create_file, delete_file, or update_file operations applied via
-          # apply_patch.
-          operation: nil,
           # The type of the item. Always `apply_patch_call`.
           type: :apply_patch_call
         )
@@ -103,53 +89,18 @@ module OpenAI
             {
               id: String,
               call_id: String,
+              operation:
+                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::Variants,
               status:
                 OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol,
               type: Symbol,
-              created_by: String,
-              operation:
-                OpenAI::Responses::ResponseApplyPatchToolCall::Operation::Variants
+              created_by: String
             }
           )
         end
         def to_hash
         end
 
-        # The status of the apply patch tool call. One of `in_progress` or `completed`.
-        module Status
-          extend OpenAI::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                OpenAI::Responses::ResponseApplyPatchToolCall::Status
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          IN_PROGRESS =
-            T.let(
-              :in_progress,
-              OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
-            )
-          COMPLETED =
-            T.let(
-              :completed,
-              OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
         # One of the create_file, delete_file, or update_file operations applied via
         # apply_patch.
         module Operation
@@ -294,6 +245,41 @@ module OpenAI
           def self.variants
           end
         end
+
+        # The status of the apply patch tool call. One of `in_progress` or `completed`.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::ResponseApplyPatchToolCall::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseApplyPatchToolCall::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/openai/models/responses/response_apply_patch_tool_call_output.rbi

@@ -21,10 +21,6 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :call_id
 
-        # Optional textual output returned by the apply patch tool.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :output
-
         # The status of the apply patch tool call output. One of `completed` or `failed`.
         sig do
           returns(
@@ -44,15 +40,19 @@ module OpenAI
         sig { params(created_by: String).void }
         attr_writer :created_by
 
+        # Optional textual output returned by the apply patch tool.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :output
+
         # The output emitted by an apply patch tool call.
         sig do
           params(
             id: String,
             call_id: String,
-            output: T.nilable(String),
             status:
               OpenAI::Responses::ResponseApplyPatchToolCallOutput::Status::OrSymbol,
             created_by: String,
+            output: T.nilable(String),
             type: Symbol
           ).returns(T.attached_class)
         end
@@ -62,12 +62,12 @@ module OpenAI
           id:,
           # The unique ID of the apply patch tool call generated by the model.
           call_id:,
-          # Optional textual output returned by the apply patch tool.
-          output:,
           # The status of the apply patch tool call output. One of `completed` or `failed`.
           status:,
           # The ID of the entity that created this tool call output.
           created_by: nil,
+          # Optional textual output returned by the apply patch tool.
+          output: nil,
           # The type of the item. Always `apply_patch_call_output`.
           type: :apply_patch_call_output
         )
@@ -78,11 +78,11 @@ module OpenAI
             {
               id: String,
               call_id: String,
-              output: T.nilable(String),
               status:
                 OpenAI::Responses::ResponseApplyPatchToolCallOutput::Status::TaggedSymbol,
               type: Symbol,
-              created_by: String
+              created_by: String,
+              output: T.nilable(String)
             }
           )
         end

data/rbi/openai/models/responses/response_input_item.rbi

@@ -1667,10 +1667,7 @@ module OpenAI
           # Optional human-readable log text from the apply patch tool (e.g., patch results
           # or errors).
           sig { returns(T.nilable(String)) }
-          attr_reader :output
-
-          sig { params(output: String).void }
-          attr_writer :output
+          attr_accessor :output
 
           # The streamed output emitted by an apply patch tool call.
           sig do
@@ -1679,7 +1676,7 @@ module OpenAI
               status:
                 OpenAI::Responses::ResponseInputItem::ApplyPatchCallOutput::Status::OrSymbol,
               id: T.nilable(String),
-              output: String,
+              output: T.nilable(String),
               type: Symbol
             ).returns(T.attached_class)
           end
@@ -1707,7 +1704,7 @@ module OpenAI
                   OpenAI::Responses::ResponseInputItem::ApplyPatchCallOutput::Status::OrSymbol,
                 type: Symbol,
                 id: T.nilable(String),
-                output: String
+                output: T.nilable(String)
               }
             )
           end

data/sig/openai/models/responses/response_apply_patch_tool_call.rbs

@@ -5,10 +5,10 @@ module OpenAI
         {
           id: String,
           call_id: String,
+          operation: OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation,
           status: OpenAI::Models::Responses::ResponseApplyPatchToolCall::status,
           type: :apply_patch_call,
-          created_by: String,
-          operation: OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation
+          created_by: String
         }
 
       class ResponseApplyPatchToolCall < OpenAI::Internal::Type::BaseModel
@@ -16,6 +16,8 @@ module OpenAI
 
         attr_accessor call_id: String
 
+        attr_accessor operation: OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation
+
         attr_accessor status: OpenAI::Models::Responses::ResponseApplyPatchToolCall::status
 
         attr_accessor type: :apply_patch_call
@@ -24,41 +26,24 @@ module OpenAI
 
         def created_by=: (String) -> String
 
-        attr_reader operation: OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation?
-
-        def operation=: (
-          OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation
-        ) -> OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation
-
         def initialize: (
           id: String,
           call_id: String,
+          operation: OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation,
           status: OpenAI::Models::Responses::ResponseApplyPatchToolCall::status,
           ?created_by: String,
-          ?operation: OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation,
           ?type: :apply_patch_call
         ) -> void
 
         def to_hash: -> {
           id: String,
           call_id: String,
+          operation: OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation,
           status: OpenAI::Models::Responses::ResponseApplyPatchToolCall::status,
           type: :apply_patch_call,
-          created_by: String,
-          operation: OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation
+          created_by: String
         }
 
-        type status = :in_progress | :completed
-
-        module Status
-          extend OpenAI::Internal::Type::Enum
-
-          IN_PROGRESS: :in_progress
-          COMPLETED: :completed
-
-          def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseApplyPatchToolCall::status]
-        end
-
         type operation =
           OpenAI::Responses::ResponseApplyPatchToolCall::Operation::CreateFile
           | OpenAI::Responses::ResponseApplyPatchToolCall::Operation::DeleteFile
@@ -117,6 +102,17 @@ module OpenAI
 
           def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseApplyPatchToolCall::operation]
         end
+
+        type status = :in_progress | :completed
+
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS: :in_progress
+          COMPLETED: :completed
+
+          def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseApplyPatchToolCall::status]
+        end
       end
     end
   end

data/sig/openai/models/responses/response_apply_patch_tool_call_output.rbs

@@ -5,10 +5,10 @@ module OpenAI
         {
           id: String,
           call_id: String,
-          output: String?,
           status: OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::status,
           type: :apply_patch_call_output,
-          created_by: String
+          created_by: String,
+          output: String?
         }
 
       class ResponseApplyPatchToolCallOutput < OpenAI::Internal::Type::BaseModel
@@ -16,8 +16,6 @@ module OpenAI
 
         attr_accessor call_id: String
 
-        attr_accessor output: String?
-
         attr_accessor status: OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::status
 
         attr_accessor type: :apply_patch_call_output
@@ -26,22 +24,24 @@ module OpenAI
 
         def created_by=: (String) -> String
 
+        attr_accessor output: String?
+
         def initialize: (
           id: String,
           call_id: String,
-          output: String?,
           status: OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::status,
           ?created_by: String,
+          ?output: String?,
           ?type: :apply_patch_call_output
         ) -> void
 
         def to_hash: -> {
           id: String,
           call_id: String,
-          output: String?,
           status: OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput::status,
           type: :apply_patch_call_output,
-          created_by: String
+          created_by: String,
+          output: String?
         }
 
         type status = :completed | :failed

data/sig/openai/models/responses/response_input_item.rbs

@@ -645,7 +645,7 @@ module OpenAI
             status: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::status,
             type: :apply_patch_call_output,
             id: String?,
-            output: String
+            output: String?
           }
 
         class ApplyPatchCallOutput < OpenAI::Internal::Type::BaseModel
@@ -657,15 +657,13 @@ module OpenAI
 
           attr_accessor id: String?
 
-          attr_reader output: String?
-
-          def output=: (String) -> String
+          attr_accessor output: String?
 
           def initialize: (
             call_id: String,
             status: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::status,
             ?id: String?,
-            ?output: String,
+            ?output: String?,
             ?type: :apply_patch_call_output
           ) -> void
 
@@ -674,7 +672,7 @@ module OpenAI
             status: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::status,
             type: :apply_patch_call_output,
             id: String?,
-            output: String
+            output: String?
           }
 
           type status = :completed | :failed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.36.1
 platform: ruby
 authors:
 - OpenAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-13 00:00:00.000000000 Z
+date: 2025-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool