openai 0.88.0 → 0.90.0

data/lib/openai/resources/beta/agents/vaults/credentials.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+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).
+            #
+            # @overload create(vault_id, auth:, name:, request_options: {})
+            #
+            # @param vault_id [String]
+            #   The ID of the vault.
+            #
+            # @param auth [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer]
+            #   The authentication method and secret values to store for the MCP server.
+            #
+            # @param name [String]
+            #   The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
+            #   trimming.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Vaults::Credential]
+            #
+            # @see OpenAI::Models::Beta::Agents::Vaults::CredentialCreateParams
+            def create(vault_id, params)
+              parsed, options = OpenAI::Beta::Agents::Vaults::CredentialCreateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: ["vaults/%1$s/credentials", vault_id],
+                body: parsed,
+                model: OpenAI::Beta::Agents::Vaults::Credential,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+              )
+            end
+
+            # Retrieves vault credential metadata without returning secret values. See
+            # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+            #
+            # @overload retrieve(credential_id, vault_id:, request_options: {})
+            #
+            # @param credential_id [String]
+            #   The ID of the vault credential.
+            #
+            # @param vault_id [String]
+            #   The ID of the vault.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Vaults::Credential]
+            #
+            # @see OpenAI::Models::Beta::Agents::Vaults::CredentialRetrieveParams
+            def retrieve(credential_id, params)
+              parsed, options = OpenAI::Beta::Agents::Vaults::CredentialRetrieveParams.dump_request(params)
+              vault_id = parsed.delete(:vault_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+
+              @client.request(
+                method: :get,
+                path: ["vaults/%1$s/credentials/%2$s", vault_id, credential_id],
+                model: OpenAI::Beta::Agents::Vaults::Credential,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **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).
+            #
+            # @overload update(credential_id, vault_id:, auth:, request_options: {})
+            #
+            # @param credential_id [String]
+            #   Path param: The ID of the vault credential.
+            #
+            # @param vault_id [String]
+            #   Path param: The ID of the vault.
+            #
+            # @param auth [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::StaticBearer]
+            #   Body param: Replacement values for the credential's existing authentication
+            #   method.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Vaults::Credential]
+            #
+            # @see OpenAI::Models::Beta::Agents::Vaults::CredentialUpdateParams
+            def update(credential_id, params)
+              parsed, options = OpenAI::Beta::Agents::Vaults::CredentialUpdateParams.dump_request(params)
+              vault_id = parsed.delete(:vault_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+
+              @client.request(
+                method: :post,
+                path: ["vaults/%1$s/credentials/%2$s", vault_id, credential_id],
+                body: parsed,
+                model: OpenAI::Beta::Agents::Vaults::Credential,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **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).
+            #
+            # @overload list(vault_id, after: nil, limit: nil, order: nil, status: nil, request_options: {})
+            #
+            # @param vault_id [String]
+            #   The ID of the vault.
+            #
+            # @param after [String]
+            #   Return resources after this resource ID in the selected order.
+            #
+            # @param limit [Integer, nil]
+            #   The maximum number of resources to return. Defaults to 20. Values are clamped
+            #   between 1 and 100.
+            #
+            # @param order [Symbol, OpenAI::Models::Beta::Agents::Vaults::CredentialListParams::Order]
+            #   Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+            #   `desc` for descending order. Defaults to `desc`.
+            #
+            # @param status [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>]
+            #   Filter by one status or a list, such as `status=active` or
+            #   `status[]=active&status[]=archived`. Both statuses are included by default.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agents::Vaults::Credential>]
+            #
+            # @see OpenAI::Models::Beta::Agents::Vaults::CredentialListParams
+            def list(vault_id, params = {})
+              parsed, options = OpenAI::Beta::Agents::Vaults::CredentialListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: ["vaults/%1$s/credentials", vault_id],
+                query: query,
+                page: OpenAI::Internal::CursorPage,
+                model: OpenAI::Beta::Agents::Vaults::Credential,
+                security: {bearer_auth: true},
+                options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+              )
+            end
+
+            # Deletes a vault credential. See
+            # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+            #
+            # @overload delete(credential_id, vault_id:, request_options: {})
+            #
+            # @param credential_id [String]
+            #   The ID of the vault credential.
+            #
+            # @param vault_id [String]
+            #   The ID of the vault.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Beta::Agents::Vaults::CredentialDeleted]
+            #
+            # @see OpenAI::Models::Beta::Agents::Vaults::CredentialDeleteParams
+            def delete(credential_id, params)
+              parsed, options = OpenAI::Beta::Agents::Vaults::CredentialDeleteParams.dump_request(params)
+              vault_id = parsed.delete(:vault_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+
+              @client.request(
+                method: :delete,
+                path: ["vaults/%1$s/credentials/%2$s", vault_id, credential_id],
+                model: OpenAI::Beta::Agents::Vaults::CredentialDeleted,
+                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

data/lib/openai/resources/beta/agents/vaults.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Beta
+      class Agents
+        class Vaults
+          # @return [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).
+          #
+          # @overload create(metadata: nil, name: nil, request_options: {})
+          #
+          # @param metadata [Hash{Symbol=>String}, nil]
+          #   Key-value pairs to associate with the vault, such as an application or team
+          #   identifier.
+          #
+          # @param name [String]
+          #   The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
+          #   trimming.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Beta::Agents::Vault]
+          #
+          # @see OpenAI::Models::Beta::Agents::VaultCreateParams
+          def create(params = {})
+            parsed, options = OpenAI::Beta::Agents::VaultCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "vaults",
+              body: parsed,
+              model: OpenAI::Beta::Agents::Vault,
+              security: {bearer_auth: true},
+              options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+            )
+          end
+
+          # Retrieves a vault by its ID. See
+          # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+          #
+          # @overload retrieve(vault_id, request_options: {})
+          #
+          # @param vault_id [String]
+          #   The ID of the vault.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Beta::Agents::Vault]
+          #
+          # @see OpenAI::Models::Beta::Agents::VaultRetrieveParams
+          def retrieve(vault_id, params = {})
+            @client.request(
+              method: :get,
+              path: ["vaults/%1$s", vault_id],
+              model: OpenAI::Beta::Agents::Vault,
+              security: {bearer_auth: true},
+              options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
+            )
+          end
+
+          # Lists vaults using ID-based pagination. See
+          # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+          #
+          # @overload list(after: nil, limit: nil, order: nil, status: nil, request_options: {})
+          #
+          # @param after [String]
+          #   Return resources after this resource ID in the selected order.
+          #
+          # @param limit [Integer, nil]
+          #   The maximum number of resources to return. Defaults to 20. Values are clamped
+          #   between 1 and 100.
+          #
+          # @param order [Symbol, OpenAI::Models::Beta::Agents::VaultListParams::Order]
+          #   Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          #   `desc` for descending order. Defaults to `desc`.
+          #
+          # @param status [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>]
+          #   Filter by one status or a list, such as `status=active` or
+          #   `status[]=active&status[]=archived`. Both statuses are included by default.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agents::Vault>]
+          #
+          # @see OpenAI::Models::Beta::Agents::VaultListParams
+          def list(params = {})
+            parsed, options = OpenAI::Beta::Agents::VaultListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: "vaults",
+              query: query,
+              page: OpenAI::Internal::CursorPage,
+              model: OpenAI::Beta::Agents::Vault,
+              security: {bearer_auth: true},
+              options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+            )
+          end
+
+          # Deletes a vault and all its credentials. See
+          # [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
+          #
+          # @overload delete(vault_id, request_options: {})
+          #
+          # @param vault_id [String]
+          #   The ID of the vault.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Beta::Agents::VaultDeleted]
+          #
+          # @see OpenAI::Models::Beta::Agents::VaultDeleteParams
+          def delete(vault_id, params = {})
+            @client.request(
+              method: :delete,
+              path: ["vaults/%1$s", vault_id],
+              model: OpenAI::Beta::Agents::VaultDeleted,
+              security: {bearer_auth: true},
+              options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
+            )
+          end
+
+          # @api private
+          #
+          # @param client [OpenAI::Client]
+          def initialize(client:)
+            @client = client
+            @credentials = OpenAI::Resources::Beta::Agents::Vaults::Credentials.new(client: client)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Beta
+      class Agents
+        # @return [OpenAI::Resources::Beta::Agents::Environments]
+        attr_reader :environments
+
+        # @return [OpenAI::Resources::Beta::Agents::Vaults]
+        attr_reader :vaults
+
+        # @return [OpenAI::Resources::Beta::Agents::Sessions]
+        attr_reader :sessions
+
+        # Creates a reusable agent without storing credentials. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        #
+        # @overload create(model:, instructions: nil, metadata: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        #
+        # @param model [String]
+        #   The model to use for the agent. The requested model name is preserved.
+        #
+        # @param instructions [String, nil]
+        #   Additional instructions appended to the agent's default base instructions. Omit
+        #   or set to null to add no custom instructions.
+        #
+        # @param metadata [Hash{Symbol=>String}, 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.
+        #
+        # @param multi_agent [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+        #   Explicit configuration for creating and coordinating subagents.
+        #
+        # @param name [String, nil]
+        #   A human-readable name for the agent. Omission or null leaves the agent unnamed.
+        #
+        # @param reasoning [OpenAI::Models::Beta::AgentReasoningParam, nil]
+        #   Reasoning configuration for the agent.
+        #
+        # @param service_tier [Symbol, OpenAI::Models::Beta::AgentCreateParams::ServiceTier, nil]
+        #   The service tier used for model requests.
+        #
+        # @param text [OpenAI::Models::Beta::AgentTextParam, nil]
+        #   Configuration for text generated by the agent.
+        #
+        # @param tools [Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil]
+        #   Tools available to the agent. Defaults to an empty list.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Beta::Agent]
+        #
+        # @see OpenAI::Models::Beta::AgentCreateParams
+        def create(params)
+          parsed, options = OpenAI::Beta::AgentCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "agents",
+            body: parsed,
+            model: OpenAI::Beta::Agent,
+            security: {bearer_auth: true},
+            options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+          )
+        end
+
+        # Retrieves a reusable agent by ID. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        #
+        # @overload retrieve(agent_id, request_options: {})
+        #
+        # @param agent_id [String]
+        #   The ID of the reusable agent.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Beta::Agent]
+        #
+        # @see OpenAI::Models::Beta::AgentRetrieveParams
+        def retrieve(agent_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["agents/%1$s", agent_id],
+            model: OpenAI::Beta::Agent,
+            security: {bearer_auth: true},
+            options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
+          )
+        end
+
+        # Updates a reusable agent. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        #
+        # @overload update(agent_id, instructions: nil, metadata: nil, model: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        #
+        # @param agent_id [String]
+        #   The ID of the reusable agent.
+        #
+        # @param instructions [String, nil]
+        #   Additional instructions appended to the agent's default base instructions. Omit
+        #   to leave unchanged.
+        #
+        # @param metadata [Hash{Symbol=>String}, nil]
+        #   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.
+        #
+        # @param model [String]
+        #   The model to use for the agent. The requested model name is preserved.
+        #
+        # @param multi_agent [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+        #   Explicit configuration for creating and coordinating subagents.
+        #
+        # @param name [String, nil]
+        #   A replacement name. Omit to leave unchanged, or pass null to clear it.
+        #
+        # @param reasoning [OpenAI::Models::Beta::AgentReasoningParam, nil]
+        #   Reasoning configuration for the agent.
+        #
+        # @param service_tier [Symbol, OpenAI::Models::Beta::AgentUpdateParams::ServiceTier, nil]
+        #   The service tier used for model requests.
+        #
+        # @param text [OpenAI::Models::Beta::AgentTextParam, nil]
+        #   Configuration for text generated by the agent.
+        #
+        # @param tools [Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil]
+        #   Tools available to the agent.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Beta::Agent]
+        #
+        # @see OpenAI::Models::Beta::AgentUpdateParams
+        def update(agent_id, params = {})
+          parsed, options = OpenAI::Beta::AgentUpdateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["agents/%1$s", agent_id],
+            body: parsed,
+            model: OpenAI::Beta::Agent,
+            security: {bearer_auth: true},
+            options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+          )
+        end
+
+        # Lists reusable agents in the current project. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        #
+        # @overload list(after: nil, limit: nil, order: nil, request_options: {})
+        #
+        # @param after [String]
+        #   Return resources after this resource ID in the selected order.
+        #
+        # @param limit [Integer, nil]
+        #   The maximum number of resources to return.
+        #
+        # @param order [Symbol, OpenAI::Models::Beta::AgentListParams::Order]
+        #   The order in which resources are returned. Defaults to `desc`.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agent>]
+        #
+        # @see OpenAI::Models::Beta::AgentListParams
+        def list(params = {})
+          parsed, options = OpenAI::Beta::AgentListParams.dump_request(params)
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "agents",
+            query: query,
+            page: OpenAI::Internal::CursorPage,
+            model: OpenAI::Beta::Agent,
+            security: {bearer_auth: true},
+            options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
+          )
+        end
+
+        # Deletes a reusable agent. See
+        # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
+        #
+        # @overload delete(agent_id, request_options: {})
+        #
+        # @param agent_id [String]
+        #   The ID of the reusable agent.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Beta::AgentDeleted]
+        #
+        # @see OpenAI::Models::Beta::AgentDeleteParams
+        def delete(agent_id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["agents/%1$s", agent_id],
+            model: OpenAI::Beta::AgentDeleted,
+            security: {bearer_auth: true},
+            options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
+          )
+        end
+
+        # @api private
+        #
+        # @param client [OpenAI::Client]
+        def initialize(client:)
+          @client = client
+          @environments = OpenAI::Resources::Beta::Agents::Environments.new(client: client)
+          @vaults = OpenAI::Resources::Beta::Agents::Vaults.new(client: client)
+          @sessions = OpenAI::Resources::Beta::Agents::Sessions.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/beta.rb

@@ -3,6 +3,9 @@
 module OpenAI
   module Resources
     class Beta
+      # @return [OpenAI::Resources::Beta::Agents]
+      attr_reader :agents
+
       # @return [OpenAI::Resources::Beta::Responses]
       attr_reader :responses
 
@@ -22,6 +25,7 @@ module OpenAI
       # @param client [OpenAI::Client]
       def initialize(client:)
         @client = client
+        @agents = OpenAI::Resources::Beta::Agents.new(client: client)
         @responses = OpenAI::Resources::Beta::Responses.new(client: client)
         @chatkit = OpenAI::Resources::Beta::ChatKit.new(client: client)
         @assistants = OpenAI::Resources::Beta::Assistants.new(client: client)

data/lib/openai/resources/live/forks.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Live
+      class Forks
+        # @api private
+        #
+        # @param client [OpenAI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end