openai 0.88.0 → 0.90.0

data/rbi/openai/models/webhooks/live_transport_incoming_webhook_event.rbi

@@ -0,0 +1,226 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Webhooks
+
+      class LiveTransportIncomingWebhookEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Webhooks::LiveTransportIncomingWebhookEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the event was created.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig { returns(OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data) }
+        attr_reader :data
+
+        sig { params(data: OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data::OrHash).void }
+        attr_writer :data
+
+        # The type of the event. Always `live.transport.incoming`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig { returns(T.nilable(OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Object::TaggedSymbol)) }
+        attr_reader :object
+
+        sig { params(object: OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Object::OrSymbol).void }
+        attr_writer :object
+
+        # 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.
+        sig do
+          params(
+
+            id: String,
+
+            created_at: Integer,
+
+            data: OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data::OrHash,
+
+            object: OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Object::OrSymbol,
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The unique ID of the event.
+          id:,
+
+          # The Unix timestamp (in seconds) of when the event was created.
+          created_at:,
+
+          # Event data payload.
+          data:,
+
+          # The object of the event. Always `event`.
+          object: nil,
+
+          # The type of the event. Always `live.transport.incoming`.
+
+          type: :"live.transport.incoming"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data,
+              type: Symbol,
+              object: OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The `live_...` ID of the pending SIP session. Forward this value unchanged when
+          # accepting or rejecting the call through the Live API.
+          sig { returns(String) }
+          attr_accessor :session_id
+
+          # 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.
+          sig { returns(T::Array[OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data::SipHeader]) }
+          attr_accessor :sip_headers
+
+          # The incoming transport type. Always `sip`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Event data payload.
+          sig do
+            params(
+
+              session_id: String,
+
+              sip_headers: T::Array[OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data::SipHeader::OrHash],
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The `live_...` ID of the pending SIP session. Forward this value unchanged when
+            # accepting or rejecting the call through the Live API.
+            session_id:,
+
+            # 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.
+            sip_headers:,
+
+            # The incoming transport type. Always `sip`.
+
+            type: :sip
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                session_id: String,
+                sip_headers: T::Array[OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data::SipHeader],
+                type: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class SipHeader < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Data::SipHeader,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # Name of the SIP Header.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # Value of the SIP Header.
+            sig { returns(String) }
+            attr_accessor :value
+
+            # A header from the SIP Invite.
+            sig do
+              params(
+
+                name: String,
+
+                value: String
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # Name of the SIP Header.
+              name:,
+
+              # Value of the SIP Header.
+
+              value:
+            )
+            end
+
+            sig do
+              override.returns(
+                {name: String, value: String}
+              )
+            end
+            def to_hash
+            end
+
+          end
+        end
+
+        # The object of the event. Always `event`.
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Object) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT = T.let(:event, OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Object::TaggedSymbol)
+
+          sig { override.returns(T::Array[OpenAI::Webhooks::LiveTransportIncomingWebhookEvent::Object::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi

@@ -41,8 +41,8 @@ module OpenAI
         attr_writer :object
 
         # 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.
         sig do
           params(
 
@@ -101,7 +101,7 @@ module OpenAI
           end
 
           # 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.
           sig { returns(String) }
@@ -126,7 +126,7 @@ module OpenAI
           def self.new(
 
             # 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.
             call_id:,

data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi

@@ -22,6 +22,7 @@ module OpenAI
             OpenAI::Webhooks::FineTuningJobFailedWebhookEvent,
             OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent,
             OpenAI::Webhooks::LiveCallIncomingWebhookEvent,
+            OpenAI::Webhooks::LiveTransportIncomingWebhookEvent,
             OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent,
             OpenAI::Webhooks::ResponseCancelledWebhookEvent,
             OpenAI::Webhooks::ResponseCompletedWebhookEvent,

data/rbi/openai/models.rbi

@@ -150,6 +150,8 @@ module OpenAI
 
   ImagesResponse = OpenAI::Models::ImagesResponse
 
+  Live = OpenAI::Models::Live
+
   Metadata = T.let(OpenAI::Models::Metadata, OpenAI::Internal::Type::Converter)
 
   Model = OpenAI::Models::Model

data/rbi/openai/resources/beta/agents/environments/files.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+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).
+            sig {
+              params(
+                environment_id: String,
+                hosted_environment_file_param: T.any(
+                  OpenAI::Beta::HostedEnvironmentFileParam::FileID::OrHash,
+                  OpenAI::Beta::HostedEnvironmentFileParam::Inline::OrHash
+                ),
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Beta::Agents::Environments::EnvironmentFile)
+            }
+            def create(
+              # The ID of the environment.
+              environment_id,
+              # A file materialized in an OpenAI-hosted execution environment.
+              hosted_environment_file_param:,
+              request_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).
+            sig {
+              params(
+                environment_id: String,
+                limit: T.nilable(Integer),
+                order: OpenAI::Beta::Agents::Environments::FileListParams::Order::OrSymbol,
+                page: String,
+                path: T.nilable(String),
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::TokenPage[OpenAI::Beta::Agents::Environments::EnvironmentFile])
+            }
+            def list(
+              # The ID of the environment.
+              environment_id,
+              # The maximum number of files to return, between 1 and 100.
+              limit: nil,
+              # Sort by case-sensitive path components. Defaults to descending.
+              order: nil,
+              # The opaque token from the previous page. Keep the same path, order, and limit.
+              page: nil,
+              # Restrict the listing to this absolute workspace directory.
+              path: nil,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/environments/templates.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Environments
+
+          class Templates
+
+            # Creates reusable environment configuration without returning confidential setup
+            # commands or environment values. See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(
+                capability_directories: T.nilable(T::Array[String]),
+                env: T.nilable(T::Hash[Symbol, String]),
+                files: T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::HostedEnvironmentFileParam::FileID::OrHash,
+                      OpenAI::Beta::HostedEnvironmentFileParam::Inline::OrHash
+                    )
+                  ]
+                ),
+                name: T.nilable(String),
+                network: T.nilable(OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network::OrHash),
+                packages: T.nilable(OpenAI::Beta::Agents::Environments::TemplateCreateParams::Packages::OrHash),
+                plugins: T.nilable(T::Array[OpenAI::Beta::HostedPluginParam::OrHash]),
+                setup_commands: T.nilable(T::Array[OpenAI::Beta::SetupCommandParam::OrHash]),
+                skills: T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::HostedSkillParam::SkillReference::OrHash,
+                      OpenAI::Beta::HostedSkillParam::Inline::OrHash
+                    )
+                  ]
+                ),
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Beta::Agents::Environments::EnvironmentTemplate)
+            }
+            def create(
+              # Directories that contain capabilities exposed to the agent. Defaults to an empty
+              # list.
+              capability_directories: nil,
+              # Environment variables made available to the agent.
+              env: nil,
+              # Files available before the agent starts. Defaults to an empty list.
+              files: nil,
+              # An optional human-readable display name for the template.
+              name: nil,
+              # Network access for an OpenAI-hosted environment.
+              network: nil,
+              # Packages to install in an OpenAI-hosted environment.
+              packages: nil,
+              # Plugins provided as inline ZIP archives. Defaults to an empty list.
+              plugins: nil,
+              # Ordered, confidential setup commands. Command bodies are never returned.
+              setup_commands: nil,
+              # Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty
+              # list.
+              skills: nil,
+              request_options: {}
+            )
+            end
+
+            # Retrieves reusable environment configuration without returning confidential
+            # values. See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(environment_template_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Environments::EnvironmentTemplate
+              )
+            }
+            def retrieve(
+              # The ID of the reusable environment template.
+              environment_template_id,
+              request_options: {}
+            )
+            end
+
+            # Updates reusable environment configuration without returning confidential
+            # values. See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(
+                environment_template_id: String,
+                capability_directories: T.nilable(T::Array[String]),
+                env: T.nilable(T::Hash[Symbol, String]),
+                files: T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::HostedEnvironmentFileParam::FileID::OrHash,
+                      OpenAI::Beta::HostedEnvironmentFileParam::Inline::OrHash
+                    )
+                  ]
+                ),
+                name: T.nilable(String),
+                network: T.nilable(OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Network::OrHash),
+                packages: T.nilable(OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Packages::OrHash),
+                plugins: T.nilable(T::Array[OpenAI::Beta::HostedPluginParam::OrHash]),
+                setup_commands: T.nilable(T::Array[OpenAI::Beta::SetupCommandParam::OrHash]),
+                skills: T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::HostedSkillParam::SkillReference::OrHash,
+                      OpenAI::Beta::HostedSkillParam::Inline::OrHash
+                    )
+                  ]
+                ),
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Beta::Agents::Environments::EnvironmentTemplate)
+            }
+            def update(
+              # The ID of the reusable environment template.
+              environment_template_id,
+              # Directories that expose capabilities to the agent.
+              capability_directories: nil,
+              # Replacement confidential environment values.
+              env: nil,
+              # Replacement file configuration materialized for each new session.
+              files: nil,
+              # A replacement human-readable display name, or `null` to clear the name.
+              name: nil,
+              # Network access for an OpenAI-hosted environment.
+              network: nil,
+              # Packages to install in an OpenAI-hosted environment.
+              packages: nil,
+              # Replacement plugin configuration installed for each new session.
+              plugins: nil,
+              # Replacement confidential setup commands, never included in returned resources.
+              setup_commands: nil,
+              # Replacement skill configuration installed for each new session.
+              skills: nil,
+              request_options: {}
+            )
+            end
+
+            # Lists reusable environment templates without returning confidential values. See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(
+                after: String,
+                limit: Integer,
+                order: OpenAI::Beta::Agents::Environments::TemplateListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Environments::EnvironmentTemplate])
+            }
+            def list(
+              # Return resources after this resource ID in the selected order.
+              after: nil,
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              limit: nil,
+              # The order in which resources are returned. Defaults to `desc`.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # Deletes reusable environment configuration and all confidential template inputs.
+            # See
+            # [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).
+            sig {
+              params(environment_template_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Environments::EnvironmentTemplateDeleted
+              )
+            }
+            def delete(
+              # The ID of the reusable environment template.
+              environment_template_id,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/environments.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Environments
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Environments::Files) }
+          attr_reader :files
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Environments::Templates) }
+          attr_reader :templates
+
+          # Retrieves an execution environment's connection status and safe installed
+          # metadata. See
+          # [environment lifecycle](https://developers.openai.com/api/docs/guides/agents-api/environments/lifecycle).
+          sig {
+            params(environment_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+              OpenAI::Beta::Agents::EnvironmentInfo
+            )
+          }
+          def retrieve(
+            # The ID of the environment.
+            environment_id,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: OpenAI::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/sessions/artifacts.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Artifacts
+
+            # Retrieves immutable metadata for one durable session artifact. See
+            # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+            sig {
+              params(artifact_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Sessions::SessionArtifact
+              )
+            }
+            def retrieve(
+              # The immutable session artifact ID.
+              artifact_id,
+              # The ID of the session that owns the artifact.
+              session_id:,
+              request_options: {}
+            )
+            end
+
+            # Lists immutable artifacts published by completed hosted session turns. See
+            # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+            sig {
+              params(
+                session_id: String,
+                after: T.nilable(String),
+                environment_id: T.nilable(String),
+                limit: T.nilable(Integer),
+                order: OpenAI::Beta::Agents::Sessions::ArtifactListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Sessions::SessionArtifact])
+            }
+            def list(
+              # The ID of the session.
+              session_id,
+              # Return artifacts after this immutable artifact ID.
+              after: nil,
+              # Restrict the listing to artifacts produced by this environment.
+              environment_id: nil,
+              # The maximum number of artifacts to return, between 1 and 100.
+              limit: nil,
+              # Sort by creation time and ID. Defaults to descending.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # Deletes an immutable session artifact without deleting its live environment file
+            # or original Files API object. See
+            # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+            sig {
+              params(artifact_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Sessions::SessionArtifactDeleted
+              )
+            }
+            def delete(
+              # The immutable session artifact ID.
+              artifact_id,
+              # The ID of the session that owns the artifact.
+              session_id:,
+              request_options: {}
+            )
+            end
+
+            # Downloads immutable session artifact bytes after the execution environment
+            # expires. See
+            # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
+            sig {
+              params(artifact_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                T.all(StringIO, OpenAI::ResponseCarrier)
+              )
+            }
+            def content(
+              # The immutable session artifact ID.
+              artifact_id,
+              # The ID of the session that owns the artifact.
+              session_id:,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end