openai 0.89.0 → 0.91.0

data/lib/openai/models/beta/agents/vaults/credential_auth.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Vaults
+          # The MCP server and authentication configuration of a vault credential, excluding
+          # secrets.
+          module CredentialAuth
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Public metadata for an OAuth credential; tokens and client secrets are never returned.
+            variant :mcp_oauth, -> { OpenAI::Beta::Agents::Vaults::CredentialAuth::McpOauth }
+
+            # Metadata for a bearer-token credential, without automatic OAuth refresh.
+            variant :static_bearer, -> { OpenAI::Beta::Agents::Vaults::CredentialAuth::StaticBearer }
+
+            class McpOauth < OpenAI::Internal::Type::BaseModel
+              # @!attribute expires_at
+              #   When the OAuth access token expires, as an RFC 3339 timestamp, if known.
+              #
+              #   @return [String, nil]
+              required :expires_at, String, nil?: true
+
+              # @!attribute mcp_server_url
+              #   The HTTPS MCP server URL authorized by this credential.
+              #
+              #   @return [String]
+              required :mcp_server_url, String
+
+              # @!attribute refresh
+              #   Configuration used to refresh an MCP OAuth access token, excluding secret
+              #   values.
+              #
+              #   @return [OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::McpOauth::Refresh, nil]
+              required(
+                :refresh,
+                -> {
+                  OpenAI::Beta::Agents::Vaults::CredentialAuth::McpOauth::Refresh
+                },
+                nil?: true
+              )
+
+              # @!attribute type
+              #   The type of the object. Always `mcp_oauth`.
+              #
+              #   @return [Symbol, :mcp_oauth]
+              required :type, const: :mcp_oauth
+
+              # @!method initialize(expires_at:, mcp_server_url:, refresh:, type: :mcp_oauth)
+              #   Public metadata for an OAuth credential; tokens and client secrets are never
+              #   returned.
+              #
+              #   @param expires_at [String, nil]
+              #     When the OAuth access token expires, as an RFC 3339 timestamp, if known.
+              #
+              #   @param mcp_server_url [String]
+              #     The HTTPS MCP server URL authorized by this credential.
+              #
+              #   @param refresh [OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::McpOauth::Refresh, nil]
+              #     Configuration used to refresh an MCP OAuth access token, excluding secret
+              #     values.
+              #
+              #   @param type [Symbol, :mcp_oauth]
+              #     The type of the object. Always `mcp_oauth`.
+
+              # @see OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::McpOauth#refresh
+              class Refresh < OpenAI::Internal::Type::BaseModel
+                # @!attribute client_id
+                #   The OAuth client ID used when requesting a new access token.
+                #
+                #   @return [String]
+                required :client_id, String
+
+                # @!attribute resource
+                #   The resource URI sent to the OAuth token endpoint during refresh, if configured.
+                #
+                #   @return [String, nil]
+                required :resource, String, nil?: true
+
+                # @!attribute scope
+                #   Space-separated OAuth scopes requested during refresh, if configured.
+                #
+                #   @return [String, nil]
+                required :scope, String, nil?: true
+
+                # @!attribute token_endpoint
+                #   The HTTPS OAuth token endpoint used for refresh.
+                #
+                #   @return [String]
+                required :token_endpoint, String
+
+                # @!attribute token_endpoint_auth
+                #   How the OAuth client authenticates to the token endpoint, excluding its client
+                #   secret.
+                #
+                #   @return [OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuth::None, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuth::ClientSecretBasic, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuth::ClientSecretPost]
+                required :token_endpoint_auth, union: -> { OpenAI::Beta::Agents::Vaults::McpOauthTokenEndpointAuth }
+
+                # @!method initialize(client_id:, resource:, scope:, token_endpoint:, token_endpoint_auth:)
+                #   Configuration used to refresh an MCP OAuth access token, excluding secret
+                #   values.
+                #
+                #   @param client_id [String]
+                #     The OAuth client ID used when requesting a new access token.
+                #
+                #   @param resource [String, nil]
+                #     The resource URI sent to the OAuth token endpoint during refresh, if configured.
+                #
+                #   @param scope [String, nil]
+                #     Space-separated OAuth scopes requested during refresh, if configured.
+                #
+                #   @param token_endpoint [String]
+                #     The HTTPS OAuth token endpoint used for refresh.
+                #
+                #   @param token_endpoint_auth [OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuth::None, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuth::ClientSecretBasic, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuth::ClientSecretPost]
+                #     How the OAuth client authenticates to the token endpoint, excluding its client
+                #     secret.
+              end
+            end
+
+            class StaticBearer < OpenAI::Internal::Type::BaseModel
+              # @!attribute mcp_server_url
+              #   The HTTPS MCP server URL authorized by this credential.
+              #
+              #   @return [String]
+              required :mcp_server_url, String
+
+              # @!attribute type
+              #   The type of the object. Always `static_bearer`.
+              #
+              #   @return [Symbol, :static_bearer]
+              required :type, const: :static_bearer
+
+              # @!method initialize(mcp_server_url:, type: :static_bearer)
+              #   Metadata for a bearer-token credential, without automatic OAuth refresh.
+              #
+              #   @param mcp_server_url [String]
+              #     The HTTPS MCP server URL authorized by this credential.
+              #
+              #   @param type [Symbol, :static_bearer]
+              #     The type of the object. Always `static_bearer`.
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::StaticBearer)]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vaults/credential_auth_create_param.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Vaults
+          # Authentication credentials for an MCP server used by agent tools.
+          module CredentialAuthCreateParam
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # An OAuth credential for an HTTPS MCP destination.
+            variant :mcp_oauth, -> { OpenAI::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth }
+
+            # A bearer token for an MCP server, without automatic OAuth refresh.
+            variant :static_bearer, -> { OpenAI::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer }
+
+            class McpOauth < OpenAI::Internal::Type::BaseModel
+              # @!attribute access_token
+              #   A write-only OAuth access token; never returned by credential resources.
+              #
+              #   @return [String]
+              required :access_token, String
+
+              # @!attribute mcp_server_url
+              #   The HTTPS MCP server URL authorized by this credential.
+              #
+              #   @return [String]
+              required :mcp_server_url, String
+
+              # @!attribute type
+              #   The type of the object. Always `mcp_oauth`.
+              #
+              #   @return [Symbol, :mcp_oauth]
+              required :type, const: :mcp_oauth
+
+              # @!attribute expires_at
+              #   When the OAuth access token expires, as an RFC 3339 timestamp, if known.
+              #
+              #   @return [String, nil]
+              optional :expires_at, String, nil?: true
+
+              # @!attribute refresh
+              #   Configuration for refreshing the access token of an MCP OAuth credential.
+              #
+              #   @return [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth::Refresh, nil]
+              optional(
+                :refresh,
+                -> { OpenAI::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth::Refresh },
+                nil?: true
+              )
+
+              # @!method initialize(access_token:, mcp_server_url:, expires_at: nil, refresh: nil, type: :mcp_oauth)
+              #   An OAuth credential for an HTTPS MCP destination.
+              #
+              #   @param access_token [String]
+              #     A write-only OAuth access token; never returned by credential resources.
+              #
+              #   @param mcp_server_url [String]
+              #     The HTTPS MCP server URL authorized by this credential.
+              #
+              #   @param expires_at [String, nil]
+              #     When the OAuth access token expires, as an RFC 3339 timestamp, if known.
+              #
+              #   @param refresh [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth::Refresh, nil]
+              #     Configuration for refreshing the access token of an MCP OAuth credential.
+              #
+              #   @param type [Symbol, :mcp_oauth]
+              #     The type of the object. Always `mcp_oauth`.
+
+              # @see OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth#refresh
+              class Refresh < OpenAI::Internal::Type::BaseModel
+                # @!attribute client_id
+                #   The OAuth client ID used when requesting a new access token.
+                #
+                #   @return [String]
+                required :client_id, String
+
+                # @!attribute refresh_token
+                #   The refresh token to store. This secret is never returned in credential
+                #   resources.
+                #
+                #   @return [String]
+                required :refresh_token, String
+
+                # @!attribute token_endpoint
+                #   The HTTPS OAuth token endpoint used to exchange the refresh token for a new
+                #   access token.
+                #
+                #   @return [String]
+                required :token_endpoint, String
+
+                # @!attribute token_endpoint_auth
+                #   How the OAuth client authenticates to the token endpoint.
+                #
+                #   @return [OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam::None, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam::ClientSecretBasic, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam::ClientSecretPost]
+                required(
+                  :token_endpoint_auth,
+                  union: -> { OpenAI::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam }
+                )
+
+                # @!attribute resource
+                #   The resource URI to send to the OAuth token endpoint during refresh, if
+                #   required.
+                #
+                #   @return [String, nil]
+                optional :resource, String, nil?: true
+
+                # @!attribute scope
+                #   Space-separated OAuth scopes to request during refresh, if required.
+                #
+                #   @return [String, nil]
+                optional :scope, String, nil?: true
+
+                # @!method initialize(client_id:, refresh_token:, token_endpoint:, token_endpoint_auth:, resource: nil, scope: nil)
+                #   Configuration for refreshing the access token of an MCP OAuth credential.
+                #
+                #   @param client_id [String]
+                #     The OAuth client ID used when requesting a new access token.
+                #
+                #   @param refresh_token [String]
+                #     The refresh token to store. This secret is never returned in credential
+                #     resources.
+                #
+                #   @param token_endpoint [String]
+                #     The HTTPS OAuth token endpoint used to exchange the refresh token for a new
+                #     access token.
+                #
+                #   @param token_endpoint_auth [OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam::None, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam::ClientSecretBasic, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthCreateParam::ClientSecretPost]
+                #     How the OAuth client authenticates to the token endpoint.
+                #
+                #   @param resource [String, nil]
+                #     The resource URI to send to the OAuth token endpoint during refresh, if
+                #     required.
+                #
+                #   @param scope [String, nil]
+                #     Space-separated OAuth scopes to request during refresh, if required.
+              end
+            end
+
+            class StaticBearer < OpenAI::Internal::Type::BaseModel
+              # @!attribute token
+              #   The bearer token to store. This secret is never returned in credential
+              #   resources.
+              #
+              #   @return [String]
+              required :token, String
+
+              # @!attribute mcp_server_url
+              #   The HTTPS MCP server URL authorized by this credential.
+              #
+              #   @return [String]
+              required :mcp_server_url, String
+
+              # @!attribute type
+              #   The type of the object. Always `static_bearer`.
+              #
+              #   @return [Symbol, :static_bearer]
+              required :type, const: :static_bearer
+
+              # @!method initialize(token:, mcp_server_url:, type: :static_bearer)
+              #   A bearer token for an MCP server, without automatic OAuth refresh.
+              #
+              #   @param token [String]
+              #     The bearer token to store. This secret is never returned in credential
+              #     resources.
+              #
+              #   @param mcp_server_url [String]
+              #     The HTTPS MCP server URL authorized by this credential.
+              #
+              #   @param type [Symbol, :static_bearer]
+              #     The type of the object. Always `static_bearer`.
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer)]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vaults/credential_auth_rotate_param.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Vaults
+          # Updates to a vault credential without changing its authentication method or MCP
+          # server.
+          module CredentialAuthRotateParam
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Rotate an OAuth credential for an HTTPS MCP destination.
+            variant :mcp_oauth, -> { OpenAI::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth }
+
+            # Replace the bearer token for the credential's MCP server.
+            variant :static_bearer, -> { OpenAI::Beta::Agents::Vaults::CredentialAuthRotateParam::StaticBearer }
+
+            class McpOauth < OpenAI::Internal::Type::BaseModel
+              # @!attribute type
+              #   The type of the object. Always `mcp_oauth`.
+              #
+              #   @return [Symbol, :mcp_oauth]
+              required :type, const: :mcp_oauth
+
+              # @!attribute access_token
+              #   A write-only replacement OAuth access token.
+              #
+              #   @return [String, nil]
+              optional :access_token, String, nil?: true
+
+              # @!attribute expires_at
+              #   The replacement expiry as an RFC 3339 timestamp, or `null` to clear it. Omitting
+              #   this field preserves the expiry unless a new access token is supplied, in which
+              #   case the expiry is cleared.
+              #
+              #   @return [String, nil]
+              optional :expires_at, String, nil?: true
+
+              # @!attribute refresh
+              #   Updates to an MCP credential's existing OAuth refresh configuration.
+              #
+              #   @return [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth::Refresh, nil]
+              optional(
+                :refresh,
+                -> { OpenAI::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth::Refresh },
+                nil?: true
+              )
+
+              # @!method initialize(access_token: nil, expires_at: nil, refresh: nil, type: :mcp_oauth)
+              #   Rotate an OAuth credential for an HTTPS MCP destination.
+              #
+              #   @param access_token [String, nil]
+              #     A write-only replacement OAuth access token.
+              #
+              #   @param expires_at [String, nil]
+              #     The replacement expiry as an RFC 3339 timestamp, or `null` to clear it. Omitting
+              #     this field preserves the expiry unless a new access token is supplied, in which
+              #     case the expiry is cleared.
+              #
+              #   @param refresh [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth::Refresh, nil]
+              #     Updates to an MCP credential's existing OAuth refresh configuration.
+              #
+              #   @param type [Symbol, :mcp_oauth]
+              #     The type of the object. Always `mcp_oauth`.
+
+              # @see OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth#refresh
+              class Refresh < OpenAI::Internal::Type::BaseModel
+                # @!attribute refresh_token
+                #   The replacement refresh token. Omit or pass `null` to keep the stored token.
+                #   This secret is never returned in resources.
+                #
+                #   @return [String, nil]
+                optional :refresh_token, String, nil?: true
+
+                # @!attribute scope
+                #   Replacement space-separated OAuth scopes for refresh requests. Omit to keep the
+                #   scopes, or pass `null` to stop sending a scope parameter.
+                #
+                #   @return [String, nil]
+                optional :scope, String, nil?: true
+
+                # @!attribute token_endpoint_auth
+                #   Client-secret updates that preserve the credential's OAuth authentication
+                #   method.
+                #
+                #   @return [OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthRotateParam::ClientSecretBasic, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthRotateParam::ClientSecretPost, nil]
+                optional(
+                  :token_endpoint_auth,
+                  union: -> {
+                    OpenAI::Beta::Agents::Vaults::McpOauthTokenEndpointAuthRotateParam
+                  },
+                  nil?: true
+                )
+
+                # @!method initialize(refresh_token: nil, scope: nil, token_endpoint_auth: nil)
+                #   Updates to an MCP credential's existing OAuth refresh configuration.
+                #
+                #   @param refresh_token [String, nil]
+                #     The replacement refresh token. Omit or pass `null` to keep the stored token.
+                #     This secret is never returned in resources.
+                #
+                #   @param scope [String, nil]
+                #     Replacement space-separated OAuth scopes for refresh requests. Omit to keep the
+                #     scopes, or pass `null` to stop sending a scope parameter.
+                #
+                #   @param token_endpoint_auth [OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthRotateParam::ClientSecretBasic, OpenAI::Models::Beta::Agents::Vaults::McpOauthTokenEndpointAuthRotateParam::ClientSecretPost, nil]
+                #     Client-secret updates that preserve the credential's OAuth authentication
+                #     method.
+              end
+            end
+
+            class StaticBearer < OpenAI::Internal::Type::BaseModel
+              # @!attribute token
+              #   The replacement bearer token. This secret is never returned in credential
+              #   resources.
+              #
+              #   @return [String]
+              required :token, String
+
+              # @!attribute type
+              #   The type of the object. Always `static_bearer`.
+              #
+              #   @return [Symbol, :static_bearer]
+              required :type, const: :static_bearer
+
+              # @!method initialize(token:, type: :static_bearer)
+              #   Replace the bearer token for the credential's MCP server.
+              #
+              #   @param token [String]
+              #     The replacement bearer token. This secret is never returned in credential
+              #     resources.
+              #
+              #   @param type [Symbol, :static_bearer]
+              #     The type of the object. Always `static_bearer`.
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthRotateParam::StaticBearer)]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vaults/credential_create_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Vaults
+          # @see OpenAI::Resources::Beta::Agents::Vaults::Credentials#create
+          class CredentialCreateParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute vault_id
+            #
+            #   @return [String]
+            required :vault_id, String
+
+            # @!attribute auth
+            #   The authentication method and secret values to store for the MCP server.
+            #
+            #   @return [OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer]
+            required :auth, union: -> { OpenAI::Beta::Agents::Vaults::CredentialAuthCreateParam }
+
+            # @!attribute name
+            #   The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
+            #   trimming.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!method initialize(vault_id:, auth:, name:, request_options: {})
+            #   @param vault_id [String]
+            #
+            #   @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}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vaults/credential_delete_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Vaults
+          # @see OpenAI::Resources::Beta::Agents::Vaults::Credentials#delete
+          class CredentialDeleteParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute vault_id
+            #
+            #   @return [String]
+            required :vault_id, String
+
+            # @!attribute credential_id
+            #
+            #   @return [String]
+            required :credential_id, String
+
+            # @!method initialize(vault_id:, credential_id:, request_options: {})
+            #   @param vault_id [String]
+            #   @param credential_id [String]
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vaults/credential_deleted.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Vaults
+          # @see OpenAI::Resources::Beta::Agents::Vaults::Credentials#delete
+          class CredentialDeleted < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The ID of the deleted credential.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute deleted
+            #   Whether the resource was deleted. Always `true`.
+            #
+            #   @return [Boolean]
+            required :deleted, OpenAI::Internal::Type::Boolean
+
+            # @!attribute object
+            #   The object type. Always `vault.credential.deleted`.
+            #
+            #   @return [Symbol, :"vault.credential.deleted"]
+            required :object, const: :"vault.credential.deleted"
+
+            # @!method initialize(id:, deleted:, object: :"vault.credential.deleted")
+            #   Confirmation that a vault credential was deleted.
+            #
+            #   @param id [String]
+            #     The ID of the deleted credential.
+            #
+            #   @param deleted [Boolean]
+            #     Whether the resource was deleted. Always `true`.
+            #
+            #   @param object [Symbol, :"vault.credential.deleted"]
+            #     The object type. Always `vault.credential.deleted`.
+          end
+        end
+      end
+    end
+  end
+end