openai 0.89.0 → 0.90.0

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

@@ -0,0 +1,74 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Subagents
+
+            sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Subagents::Items) }
+            attr_reader :items
+
+            sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns) }
+            attr_reader :turns
+
+            # Retrieves a subagent belonging to this session. See
+            # [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
+            sig {
+              params(subagent_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Subagent
+              )
+            }
+            def retrieve(
+              # The ID of the subagent in this session.
+              subagent_id,
+              # The ID of the session.
+              session_id:,
+              request_options: {}
+            )
+            end
+
+            # Lists subagents in a session, including nested and closed subagents. See
+            # [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
+            sig {
+              params(
+                session_id: String,
+                after: String,
+                limit: Integer,
+                order: OpenAI::Beta::Agents::Sessions::SubagentListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Subagent])
+            }
+            def list(
+              # The ID of the session.
+              session_id,
+              # 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
+
+            # @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/sessions/turns.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Turns
+
+            # Retrieves a turn's current status, timestamps, usage, and error. Returns 404 if
+            # the turn does not belong to the session. See
+            # [session turns](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage#inspect-session-turns).
+            sig {
+              params(turn_id: String, session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Sessions::Turn
+              )
+            }
+            def retrieve(
+              # The ID of the turn.
+              turn_id,
+              # The ID of the session that owns the turn.
+              session_id:,
+              request_options: {}
+            )
+            end
+
+            # Lists turns by creation time and turn ID. The after cursor is exclusive in the
+            # selected order. See
+            # [session turns](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage#inspect-session-turns).
+            sig {
+              params(
+                session_id: String,
+                after: String,
+                limit: Integer,
+                order: OpenAI::Beta::Agents::Sessions::TurnListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Sessions::Turn])
+            }
+            def list(
+              # The ID of the session.
+              session_id,
+              # 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
+
+            # @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/sessions.rbi

@@ -0,0 +1,208 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Subagents) }
+          attr_reader :subagents
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Artifacts) }
+          attr_reader :artifacts
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Items) }
+          attr_reader :items
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Events) }
+          attr_reader :events
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Turns) }
+          attr_reader :turns
+
+          # See {OpenAI::Resources::Beta::Agents::Sessions#create_streaming} for streaming
+          # counterpart.
+          #
+          # Creates a managed agent session, optionally submits initial input, and returns
+          # the session or streams its events when stream is true. See
+          # [running sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions).
+          sig {
+            params(
+              environment: T.any(
+                OpenAI::Beta::EnvironmentParam::None::OrHash,
+                OpenAI::Beta::EnvironmentParam::OpenAIHosted::OrHash,
+                OpenAI::Beta::EnvironmentParam::SelfHosted::OrHash
+              ),
+              agent: OpenAI::Beta::Agents::SessionCreateParams::Agent::OrHash,
+              agent_id: String,
+              input: T.nilable(OpenAI::Beta::Agents::SessionCreateParams::Input::Variants),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              vault_ids: T.nilable(T::Array[String]),
+              stream: T.noreturn,
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Beta::AgentSession)
+          }
+          def create(
+            # An inline execution environment or a reference to an environment template.
+            environment:,
+            # Agent configuration. With `agent_id`, supplied fields override the saved agent
+            # for this session. Without `agent_id`, `model` is required.
+            agent: nil,
+            # The ID of a saved reusable agent. Omit `agent` to use its configuration
+            # unchanged.
+            agent_id: nil,
+            # Initial input submitted when creating a session.
+            input: nil,
+            # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+            # characters. Omission or null defaults to an empty map.
+            metadata: nil,
+            # The IDs of vaults made available to the session.
+            vault_ids: nil,
+            # There is no need to provide `stream:`. Instead, use `#create_streaming` or
+            # `#create` for streaming and non-streaming use cases, respectively.
+            stream: false,
+            request_options: {}
+          )
+          end
+
+          # See {OpenAI::Resources::Beta::Agents::Sessions#create} for non-streaming
+          # counterpart.
+          #
+          # Creates a managed agent session, optionally submits initial input, and returns
+          # the session or streams its events when stream is true. See
+          # [running sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions).
+          sig {
+            params(
+              environment: T.any(
+                OpenAI::Beta::EnvironmentParam::None::OrHash,
+                OpenAI::Beta::EnvironmentParam::OpenAIHosted::OrHash,
+                OpenAI::Beta::EnvironmentParam::SelfHosted::OrHash
+              ),
+              agent: OpenAI::Beta::Agents::SessionCreateParams::Agent::OrHash,
+              agent_id: String,
+              input: T.nilable(OpenAI::Beta::Agents::SessionCreateParams::Input::Variants),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              vault_ids: T.nilable(T::Array[String]),
+              stream: T.noreturn,
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Internal::Stream[OpenAI::Beta::AgentSessionEvent::Variants])
+          }
+          def create_streaming(
+            # An inline execution environment or a reference to an environment template.
+            environment:,
+            # Agent configuration. With `agent_id`, supplied fields override the saved agent
+            # for this session. Without `agent_id`, `model` is required.
+            agent: nil,
+            # The ID of a saved reusable agent. Omit `agent` to use its configuration
+            # unchanged.
+            agent_id: nil,
+            # Initial input submitted when creating a session.
+            input: nil,
+            # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+            # characters. Omission or null defaults to an empty map.
+            metadata: nil,
+            # The IDs of vaults made available to the session.
+            vault_ids: nil,
+            # There is no need to provide `stream:`. Instead, use `#create_streaming` or
+            # `#create` for streaming and non-streaming use cases, respectively.
+            stream: true,
+            request_options: {}
+          )
+          end
+
+          # Retrieves the current state of a managed agent session. See
+          # [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
+          sig {
+            params(session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+              OpenAI::Beta::AgentSession
+            )
+          }
+          def retrieve(
+            # The ID of the session.
+            session_id,
+            request_options: {}
+          )
+          end
+
+          # Updates session metadata. Omitted fields are unchanged. See
+          # [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
+          sig {
+            params(
+              session_id: String,
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Beta::AgentSession)
+          }
+          def update(
+            # The ID of the session.
+            session_id,
+            # Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
+            # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+            # characters.
+            metadata: nil,
+            request_options: {}
+          )
+          end
+
+          # Lists managed agent sessions using ID-based pagination and the requested sort
+          # order. See
+          # [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
+          sig {
+            params(
+              after: String,
+              agent_id: String,
+              limit: T.nilable(Integer),
+              order: OpenAI::Beta::Agents::SessionListParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::AgentSession])
+          }
+          def list(
+            # Return resources after this resource ID in the selected order.
+            after: nil,
+            # Only return sessions whose root agent has this ID. Omit to return sessions for
+            # all agents.
+            agent_id: nil,
+            # The maximum number of resources to return.
+            limit: nil,
+            # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+            # `desc` for descending order. Defaults to `desc`.
+            order: nil,
+            request_options: {}
+          )
+          end
+
+          # Removes a managed agent session from the public API and returns a deletion
+          # confirmation. Physical cleanup may continue asynchronously. See
+          # [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
+          sig {
+            params(session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+              OpenAI::Beta::AgentSessionDeleted
+            )
+          }
+          def delete(
+            # The ID of the session.
+            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

data/rbi/openai/resources/beta/agents/vaults/credentials.rbi

@@ -0,0 +1,148 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Vaults
+
+          class Credentials
+
+            # Creates a vault credential. Secret values are write-only and are never returned.
+            # See
+            # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+            sig {
+              params(
+                vault_id: String,
+                auth: T.any(
+                  OpenAI::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth::OrHash,
+                  OpenAI::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer::OrHash
+                ),
+                name: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Beta::Agents::Vaults::Credential)
+            }
+            def create(
+              # The ID of the vault.
+              vault_id,
+              # The authentication method and secret values to store for the MCP server.
+              auth:,
+              # The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
+              # trimming.
+              name:,
+              request_options: {}
+            )
+            end
+
+            # Retrieves vault credential metadata without returning secret values. See
+            # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+            sig {
+              params(credential_id: String, vault_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Vaults::Credential
+              )
+            }
+            def retrieve(
+              # The ID of the vault credential.
+              credential_id,
+              # The ID of the vault.
+              vault_id:,
+              request_options: {}
+            )
+            end
+
+            # Rotates a vault credential's write-only secret and returns only credential
+            # metadata. See
+            # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+            sig {
+              params(
+                credential_id: String,
+                vault_id: String,
+                auth: T.any(
+                  OpenAI::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth::OrHash,
+                  OpenAI::Beta::Agents::Vaults::CredentialAuthRotateParam::StaticBearer::OrHash
+                ),
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Beta::Agents::Vaults::Credential)
+            }
+            def update(
+              # Path param: The ID of the vault credential.
+              credential_id,
+              # Path param: The ID of the vault.
+              vault_id:,
+              # Body param: Replacement values for the credential's existing authentication
+              # method.
+              auth:,
+              request_options: {}
+            )
+            end
+
+            # Lists a vault's credentials using ID-based pagination without returning secret
+            # values. See
+            # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+            sig {
+              params(
+                vault_id: String,
+                after: String,
+                limit: T.nilable(Integer),
+                order: OpenAI::Beta::Agents::Vaults::CredentialListParams::Order::OrSymbol,
+                status: T.any(
+                  OpenAI::Beta::Agents::VaultStatus::OrSymbol,
+                  T::Array[OpenAI::Beta::Agents::VaultStatus::OrSymbol]
+                ),
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Vaults::Credential])
+            }
+            def list(
+              # The ID of the vault.
+              vault_id,
+              # Return resources after this resource ID in the selected order.
+              after: nil,
+              # The maximum number of resources to return. Defaults to 20. Values are clamped
+              # between 1 and 100.
+              limit: nil,
+              # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+              # `desc` for descending order. Defaults to `desc`.
+              order: nil,
+              # Filter by one status or a list, such as `status=active` or
+              # `status[]=active&status[]=archived`. Both statuses are included by default.
+              status: nil,
+              request_options: {}
+            )
+            end
+
+            # Deletes a vault credential. See
+            # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+            sig {
+              params(credential_id: String, vault_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+                OpenAI::Beta::Agents::Vaults::CredentialDeleted
+              )
+            }
+            def delete(
+              # The ID of the vault credential.
+              credential_id,
+              # The ID of the vault.
+              vault_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/vaults.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Vaults
+
+          sig { returns(OpenAI::Resources::Beta::Agents::Vaults::Credentials) }
+          attr_reader :credentials
+
+          # Creates a vault for the current project. See
+          # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+          sig {
+            params(
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              name: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Beta::Agents::Vault)
+          }
+          def create(
+            # Key-value pairs to associate with the vault, such as an application or team
+            # identifier.
+            metadata: nil,
+            # The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
+            # trimming.
+            name: nil,
+            request_options: {}
+          )
+          end
+
+          # Retrieves a vault by its ID. See
+          # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+          sig {
+            params(vault_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+              OpenAI::Beta::Agents::Vault
+            )
+          }
+          def retrieve(
+            # The ID of the vault.
+            vault_id,
+            request_options: {}
+          )
+          end
+
+          # Lists vaults using ID-based pagination. See
+          # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+          sig {
+            params(
+              after: String,
+              limit: T.nilable(Integer),
+              order: OpenAI::Beta::Agents::VaultListParams::Order::OrSymbol,
+              status: T.any(
+                OpenAI::Beta::Agents::VaultStatus::OrSymbol,
+                T::Array[OpenAI::Beta::Agents::VaultStatus::OrSymbol]
+              ),
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Vault])
+          }
+          def list(
+            # Return resources after this resource ID in the selected order.
+            after: nil,
+            # The maximum number of resources to return. Defaults to 20. Values are clamped
+            # between 1 and 100.
+            limit: nil,
+            # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+            # `desc` for descending order. Defaults to `desc`.
+            order: nil,
+            # Filter by one status or a list, such as `status=active` or
+            # `status[]=active&status[]=archived`. Both statuses are included by default.
+            status: nil,
+            request_options: {}
+          )
+          end
+
+          # Deletes a vault and all its credentials. See
+          # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+          sig {
+            params(vault_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+              OpenAI::Beta::Agents::VaultDeleted
+            )
+          }
+          def delete(
+            # The ID of the vault.
+            vault_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