openai 0.88.0 → 0.90.0

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

@@ -285,6 +285,36 @@ module OpenAI
           #   @return [Symbol, :image_generation_call]
           required :type, const: :image_generation_call
 
+          # @!attribute action
+          #   The action used for image generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Action, nil]
+          optional(
+            :action,
+            enum: -> { OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action },
+            nil?: true
+          )
+
+          # @!attribute background
+          #   The background setting used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Background, nil]
+          optional(
+            :background,
+            enum: -> { OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background },
+            nil?: true
+          )
+
+          # @!attribute output_format
+          #   The output format used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat, nil]
+          optional(
+            :output_format,
+            enum: -> { OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat },
+            nil?: true
+          )
+
           # @!attribute quality
           #   The quality of the image generated by the image generation tool call. One of
           #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
@@ -296,6 +326,12 @@ module OpenAI
             nil?: true
           )
 
+          # @!attribute revised_prompt
+          #   The prompt that was used after any model prompt rewriting.
+          #
+          #   @return [String, nil]
+          optional :revised_prompt, String, nil?: true
+
           # @!attribute size
           #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
@@ -308,7 +344,7 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(id:, result:, status:, quality: nil, size: nil, type: :image_generation_call)
+          # @!method initialize(id:, result:, status:, action: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
           #   An image generation request made by the model.
           #
           #   @param id [String]
@@ -320,10 +356,22 @@ module OpenAI
           #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Status]
           #     The status of the image generation call.
           #
+          #   @param action [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Action, nil]
+          #     The action used for image generation.
+          #
+          #   @param background [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Background, nil]
+          #     The background setting used for generation.
+          #
+          #   @param output_format [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat, nil]
+          #     The output format used for generation.
+          #
           #   @param quality [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Quality, nil]
           #     The quality of the image generated by the image generation tool call. One of
           #     `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #
+          #   @param revised_prompt [String, nil]
+          #     The prompt that was used after any model prompt rewriting.
+          #
           #   @param size [String, Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
@@ -345,6 +393,48 @@ module OpenAI
             #   @return [Array<Symbol>]
           end
 
+          # The action used for image generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall#action
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            GENERATE = :generate
+            EDIT = :edit
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The background setting used for generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall#background
+          module Background
+            extend OpenAI::Internal::Type::Enum
+
+            TRANSPARENT = :transparent
+            OPAQUE = :opaque
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The output format used for generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall#output_format
+          module OutputFormat
+            extend OpenAI::Internal::Type::Enum
+
+            PNG = :png
+            WEBP = :webp
+            JPEG = :jpeg
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #

data/lib/openai/models/webhooks/live_call_incoming_webhook_event.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module Webhooks
+      # @deprecated
       class LiveCallIncomingWebhookEvent < OpenAI::Internal::Type::BaseModel
         # @!attribute id
         #   The unique ID of the event.
@@ -35,9 +36,11 @@ module OpenAI
         optional :object, enum: -> { OpenAI::Webhooks::LiveCallIncomingWebhookEvent::Object }
 
         # @!method initialize(id:, created_at:, data:, object: nil, type: :"live.call.incoming")
-        #   Sent when an incoming API SIP session is available for Live acceptance. The same
-        #   pending session can also emit `realtime.call.incoming`; the first successful
-        #   Realtime or Live accept endpoint selects the runtime surface.
+        #   Deprecated: use `live.transport.incoming`. Retained for existing subscriptions
+        #   during migration; new subscriptions to this event are not allowed. Sent when an
+        #   incoming API SIP session is available for Live acceptance. The same pending
+        #   session can also emit `realtime.call.incoming`; the first successful Realtime or
+        #   Live accept endpoint selects the runtime surface.
         #
         #   @param id [String]
         #     The unique ID of the event.
@@ -57,8 +60,9 @@ module OpenAI
         # @see OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent#data
         class Data < OpenAI::Internal::Type::BaseModel
           # @!attribute session_id
-          #   The `live_...` ID of the pending SIP session. Forward this value unchanged when
-          #   accepting or rejecting the call through the Live API.
+          #   The `live_...` ID of the pending SIP session. Pass this value unchanged to Live
+          #   call controls and sideband connections. The corresponding
+          #   `realtime.call.incoming` event uses a separate `rtc_...` call ID.
           #
           #   @return [String]
           required :session_id, String
@@ -78,8 +82,9 @@ module OpenAI
           #   Event data payload.
           #
           #   @param session_id [String]
-          #     The `live_...` ID of the pending SIP session. Forward this value unchanged when
-          #     accepting or rejecting the call through the Live API.
+          #     The `live_...` ID of the pending SIP session. Pass this value unchanged to Live
+          #     call controls and sideband connections. The corresponding
+          #     `realtime.call.incoming` event uses a separate `rtc_...` call ID.
           #
           #   @param sip_headers [Array<OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent::Data::SipHeader>]
           #     Headers from the SIP INVITE, excluding SIP authorization headers. Retained

data/lib/openai/models/webhooks/live_transport_incoming_webhook_event.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class LiveTransportIncomingWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) of when the event was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #   Event data payload.
+        #
+        #   @return [OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data }
+
+        # @!attribute type
+        #   The type of the event. Always `live.transport.incoming`.
+        #
+        #   @return [Symbol, :"live.transport.incoming"]
+        required :type, const: :"live.transport.incoming"
+
+        # @!attribute object
+        #   The object of the event. Always `event`.
+        #
+        #   @return [Symbol, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent::Object, nil]
+        optional :object, enum: -> { OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Object }
+
+        # @!method initialize(id:, created_at:, data:, object: nil, type: :"live.transport.incoming")
+        #   Sent when an incoming API SIP session is available for Live acceptance. The same
+        #   pending session can also emit `realtime.call.incoming`; the first successful
+        #   Realtime or Live accept endpoint selects the runtime surface.
+        #
+        #   @param id [String]
+        #     The unique ID of the event.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp (in seconds) of when the event was created.
+        #
+        #   @param data [OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent::Data]
+        #     Event data payload.
+        #
+        #   @param object [Symbol, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent::Object]
+        #     The object of the event. Always `event`.
+        #
+        #   @param type [Symbol, :"live.transport.incoming"]
+        #     The type of the event. Always `live.transport.incoming`.
+
+        # @see OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute session_id
+          #   The `live_...` ID of the pending SIP session. Forward this value unchanged when
+          #   accepting or rejecting the call through the Live API.
+          #
+          #   @return [String]
+          required :session_id, String
+
+          # @!attribute sip_headers
+          #   Headers from the SIP INVITE, excluding SIP authorization headers. Retained
+          #   names, values, repeated entries, and order are preserved. Treat these values as
+          #   untrusted call metadata.
+          #
+          #   @return [Array<OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent::Data::SipHeader>]
+          required(
+            :sip_headers,
+            -> {
+              OpenAI::Internal::Type::ArrayOf[OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data::SipHeader]
+            }
+          )
+
+          # @!attribute type
+          #   The incoming transport type. Always `sip`.
+          #
+          #   @return [Symbol, :sip]
+          required :type, const: :sip
+
+          # @!method initialize(session_id:, sip_headers:, type: :sip)
+          #   Event data payload.
+          #
+          #   @param session_id [String]
+          #     The `live_...` ID of the pending SIP session. Forward this value unchanged when
+          #     accepting or rejecting the call through the Live API.
+          #
+          #   @param sip_headers [Array<OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent::Data::SipHeader>]
+          #     Headers from the SIP INVITE, excluding SIP authorization headers. Retained
+          #     names, values, repeated entries, and order are preserved. Treat these values as
+          #     untrusted call metadata.
+          #
+          #   @param type [Symbol, :sip]
+          #     The incoming transport type. Always `sip`.
+          class SipHeader < OpenAI::Internal::Type::BaseModel
+            # @!attribute name
+            #   Name of the SIP Header.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute value
+            #   Value of the SIP Header.
+            #
+            #   @return [String]
+            required :value, String
+
+            # @!method initialize(name:, value:)
+            #   A header from the SIP Invite.
+            #
+            #   @param name [String]
+            #     Name of the SIP Header.
+            #
+            #   @param value [String]
+            #     Value of the SIP Header.
+          end
+        end
+
+        # The object of the event. Always `event`.
+        #
+        # @see OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb

@@ -36,8 +36,8 @@ module OpenAI
 
         # @!method initialize(id:, created_at:, data:, object: nil, type: :"realtime.call.incoming")
         #   Sent when an incoming API SIP session is available for Realtime acceptance. The
-        #   same pending session can also emit `live.call.incoming`; the first successful
-        #   Realtime or Live accept endpoint selects the runtime surface.
+        #   same pending session can also emit `live.transport.incoming`; the first
+        #   successful Realtime or Live accept endpoint selects the runtime surface.
         #
         #   @param id [String]
         #     The unique ID of the event.
@@ -58,7 +58,7 @@ module OpenAI
         class Data < OpenAI::Internal::Type::BaseModel
           # @!attribute call_id
           #   The Transceiver `rtc_...` ID of the pending SIP session. The paired
-          #   `live.call.incoming` event derives its `session_id` by replacing the `rtc_`
+          #   `live.transport.incoming` event derives its `session_id` by replacing the `rtc_`
           #   prefix with `live_`. Use the ID returned by the event with the corresponding
           #   Realtime or Live API.
           #
@@ -81,7 +81,7 @@ module OpenAI
           #
           #   @param call_id [String]
           #     The Transceiver `rtc_...` ID of the pending SIP session. The paired
-          #     `live.call.incoming` event derives its `session_id` by replacing the `rtc_`
+          #     `live.transport.incoming` event derives its `session_id` by replacing the `rtc_`
           #     prefix with `live_`. Use the ID returned by the event with the corresponding
           #     Realtime or Live API.
           #

data/lib/openai/models/webhooks/unwrap_webhook_event.rb

@@ -39,13 +39,20 @@ module OpenAI
         # Sent when a fine-tuning job has succeeded.
         variant :"fine_tuning.job.succeeded", -> { OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent }
 
+        # Deprecated: use `live.transport.incoming`. Retained for existing subscriptions
+        # during migration; new subscriptions to this event are not allowed.
         # Sent when an incoming API SIP session is available for Live acceptance. The
         # same pending session can also emit `realtime.call.incoming`; the first
         # successful Realtime or Live accept endpoint selects the runtime surface.
         variant :"live.call.incoming", -> { OpenAI::Webhooks::LiveCallIncomingWebhookEvent }
 
+        # Sent when an incoming API SIP session is available for Live acceptance. The
+        # same pending session can also emit `realtime.call.incoming`; the first
+        # successful Realtime or Live accept endpoint selects the runtime surface.
+        variant :"live.transport.incoming", -> { OpenAI::Webhooks::LiveTransportIncomingWebhookEvent }
+
         # Sent when an incoming API SIP session is available for Realtime acceptance.
-        # The same pending session can also emit `live.call.incoming`; the first
+        # The same pending session can also emit `live.transport.incoming`; the first
         # successful Realtime or Live accept endpoint selects the runtime surface.
         variant :"realtime.call.incoming", -> { OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent }
 
@@ -68,7 +75,7 @@ module OpenAI
         variant :"safety.org_alert.created", -> { OpenAI::Webhooks::SafetyOrgAlertCreatedWebhookEvent }
 
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent)]
+        #   @return [Array(OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent)]
       end
     end
   end

data/lib/openai/models.rb

@@ -196,6 +196,8 @@ module OpenAI
 
   ImagesResponse = OpenAI::Models::ImagesResponse
 
+  Live = OpenAI::Models::Live
+
   # @type [OpenAI::Internal::Type::Converter]
   Metadata = OpenAI::Models::Metadata
 

data/lib/openai/resources/beta/agents/environments/files.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Beta
+      class Agents
+        class Environments
+          class Files
+            # Copies inline bytes or a Files API file into a connected execution environment.
+            # See
+            # [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).
+            #
+            # @overload create(environment_id, hosted_environment_file_param:, request_options: {})
+            #
+            # @param environment_id [String]
+            #   The ID of the environment.
+            #
+            # @param hosted_environment_file_param [OpenAI::Models::Beta::HostedEnvironmentFileParam::FileID, OpenAI::Models::Beta::HostedEnvironmentFileParam::Inline]
+            #   A file materialized in an OpenAI-hosted execution environment.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Environments::EnvironmentFile]
+            #
+            # @see OpenAI::Models::Beta::Agents::Environments::FileCreateParams
+            def create(environment_id, params)
+              parsed, options = OpenAI::Beta::Agents::Environments::FileCreateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: ["agents/environments/%1$s/files", environment_id],
+                body: parsed[:hosted_environment_file_param],
+                model: OpenAI::Beta::Agents::Environments::EnvironmentFile,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+              )
+            end
+
+            # Lists live files on a connected execution environment with optional directory
+            # filtering and opaque cursor pagination. See
+            # [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).
+            #
+            # @overload list(environment_id, limit: nil, order: nil, page: nil, path: nil, request_options: {})
+            #
+            # @param environment_id [String]
+            #   The ID of the environment.
+            #
+            # @param limit [Integer, nil]
+            #   The maximum number of files to return, between 1 and 100.
+            #
+            # @param order [Symbol, OpenAI::Models::Beta::Agents::Environments::FileListParams::Order]
+            #   Sort by case-sensitive path components. Defaults to descending.
+            #
+            # @param page [String]
+            #   The opaque token from the previous page. Keep the same path, order, and limit.
+            #
+            # @param path [String, nil]
+            #   Restrict the listing to this absolute workspace directory.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::TokenPage<OpenAI::Models::Beta::Agents::Environments::EnvironmentFile>]
+            #
+            # @see OpenAI::Models::Beta::Agents::Environments::FileListParams
+            def list(environment_id, params = {})
+              parsed, options = OpenAI::Beta::Agents::Environments::FileListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: ["agents/environments/%1$s/files", environment_id],
+                query: query,
+                page: OpenAI::Internal::TokenPage,
+                model: OpenAI::Beta::Agents::Environments::EnvironmentFile,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+              )
+            end
+
+            # @api private
+            #
+            # @param client [OpenAI::Client]
+            def initialize(client:)
+              @client = client
+            end
+          end
+        end
+      end
+    end
+  end
+end