openai 0.89.0 → 0.91.0

data/lib/openai/models/beta/agents/sessions/turn.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Turns#retrieve
+          class Turn < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The ID of the turn.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute agent_id
+            #   The ID of the agent that ran the turn.
+            #
+            #   @return [String]
+            required :agent_id, String
+
+            # @!attribute completed_at
+            #   The Unix timestamp, in seconds, when the turn reached a terminal state.
+            #
+            #   @return [Integer, nil]
+            required :completed_at, Integer, nil?: true
+
+            # @!attribute created_at
+            #   The Unix timestamp, in seconds, used to order the turn by creation time.
+            #   Subagent turns use their start time, falling back to completion time or the
+            #   subagent opening time when the preceding timestamps are unavailable.
+            #
+            #   @return [Integer]
+            required :created_at, Integer
+
+            # @!attribute error
+            #   A customer-safe error describing why a session request failed.
+            #
+            #   @return [OpenAI::Models::Beta::SessionTurnError, nil]
+            required :error, -> { OpenAI::Beta::SessionTurnError }, nil?: true
+
+            # @!attribute object
+            #   The object type. Always `agent.session.turn`.
+            #
+            #   @return [Symbol, :"agent.session.turn"]
+            required :object, const: :"agent.session.turn"
+
+            # @!attribute session_id
+            #   The ID of the session that owns the turn.
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!attribute started_at
+            #   The Unix timestamp, in seconds, when the turn started.
+            #
+            #   @return [Integer, nil]
+            required :started_at, Integer, nil?: true
+
+            # @!attribute status
+            #   The current status of the turn.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::Turn::Status]
+            required :status, enum: -> { OpenAI::Beta::Agents::Sessions::Turn::Status }
+
+            # @!attribute subagent_id
+            #   The ID of the subagent that ran the turn, if applicable.
+            #
+            #   @return [String, nil]
+            required :subagent_id, String, nil?: true
+
+            # @!attribute usage
+            #   Recorded token usage for a session or turn. Usage is best effort and may change.
+            #
+            #   @return [OpenAI::Models::Beta::TokenUsage, nil]
+            required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
+
+            # @!method initialize(id:, agent_id:, completed_at:, created_at:, error:, session_id:, started_at:, status:, subagent_id:, usage:, object: :"agent.session.turn")
+            #   The canonical public representation of a session turn.
+            #
+            #   @param id [String]
+            #     The ID of the turn.
+            #
+            #   @param agent_id [String]
+            #     The ID of the agent that ran the turn.
+            #
+            #   @param completed_at [Integer, nil]
+            #     The Unix timestamp, in seconds, when the turn reached a terminal state.
+            #
+            #   @param created_at [Integer]
+            #     The Unix timestamp, in seconds, used to order the turn by creation time.
+            #     Subagent turns use their start time, falling back to completion time or the
+            #     subagent opening time when the preceding timestamps are unavailable.
+            #
+            #   @param error [OpenAI::Models::Beta::SessionTurnError, nil]
+            #     A customer-safe error describing why a session request failed.
+            #
+            #   @param session_id [String]
+            #     The ID of the session that owns the turn.
+            #
+            #   @param started_at [Integer, nil]
+            #     The Unix timestamp, in seconds, when the turn started.
+            #
+            #   @param status [Symbol, OpenAI::Models::Beta::Agents::Sessions::Turn::Status]
+            #     The current status of the turn.
+            #
+            #   @param subagent_id [String, nil]
+            #     The ID of the subagent that ran the turn, if applicable.
+            #
+            #   @param usage [OpenAI::Models::Beta::TokenUsage, nil]
+            #     Recorded token usage for a session or turn. Usage is best effort and may change.
+            #
+            #   @param object [Symbol, :"agent.session.turn"]
+            #     The object type. Always `agent.session.turn`.
+
+            # The current status of the turn.
+            #
+            # @see OpenAI::Models::Beta::Agents::Sessions::Turn#status
+            module Status
+              extend OpenAI::Internal::Type::Enum
+
+              # The turn is waiting to start.
+              QUEUED = :queued
+
+              # The turn is in progress.
+              IN_PROGRESS = :in_progress
+
+              # The turn is waiting for external input.
+              WAITING = :waiting
+
+              # The turn completed successfully.
+              COMPLETED = :completed
+
+              # The turn failed.
+              FAILED = :failed
+
+              # The turn was cancelled.
+              CANCELLED = :cancelled
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/turn_list_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Turns#list
+          class TurnListParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute session_id
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!attribute after
+            #   Return resources after this resource ID in the selected order.
+            #
+            #   @return [String, nil]
+            optional :after, String
+
+            # @!attribute limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute order
+            #   The order in which resources are returned. Defaults to `desc`.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::TurnListParams::Order, nil]
+            optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::TurnListParams::Order }
+
+            # @!method initialize(session_id:, after: nil, limit: nil, order: nil, request_options: {})
+            #   @param session_id [String]
+            #
+            #   @param after [String]
+            #     Return resources after this resource ID in the selected order.
+            #
+            #   @param limit [Integer]
+            #     The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            #
+            #   @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::TurnListParams::Order]
+            #     The order in which resources are returned. Defaults to `desc`.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # The order in which resources are returned. Defaults to `desc`.
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              # Returns resources in ascending order.
+              ASC = :asc
+
+              # Returns resources in descending order.
+              DESC = :desc
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/turn_retrieve_params.rb

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

data/lib/openai/models/beta/agents/vault.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Vaults#create
+        class Vault < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the vault.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   The Unix timestamp, in seconds, when the vault was created.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute metadata
+          #   Key-value pairs associated with the vault, such as an application or team
+          #   identifier.
+          #
+          #   @return [Hash{Symbol=>String}]
+          required :metadata, OpenAI::Internal::Type::HashOf[String]
+
+          # @!attribute name
+          #   The human-readable name of the vault, if set.
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute object
+          #   The object type. Always `vault`.
+          #
+          #   @return [Symbol, :vault]
+          required :object, const: :vault
+
+          # @!method initialize(id:, created_at:, metadata:, name:, object: :vault)
+          #   A collection of credentials that agent tools can use to authenticate to MCP
+          #   servers.
+          #
+          #   @param id [String]
+          #     The ID of the vault.
+          #
+          #   @param created_at [Integer]
+          #     The Unix timestamp, in seconds, when the vault was created.
+          #
+          #   @param metadata [Hash{Symbol=>String}]
+          #     Key-value pairs associated with the vault, such as an application or team
+          #     identifier.
+          #
+          #   @param name [String, nil]
+          #     The human-readable name of the vault, if set.
+          #
+          #   @param object [Symbol, :vault]
+          #     The object type. Always `vault`.
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vault_create_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Vaults#create
+        class VaultCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute metadata
+          #   Key-value pairs to associate with the vault, such as an application or team
+          #   identifier.
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+          # @!attribute name
+          #   The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
+          #   trimming.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(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}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vault_delete_params.rb

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

data/lib/openai/models/beta/agents/vault_deleted.rb

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

data/lib/openai/models/beta/agents/vault_list_params.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Vaults#list
+        class VaultListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute after
+          #   Return resources after this resource ID in the selected order.
+          #
+          #   @return [String, nil]
+          optional :after, String
+
+          # @!attribute limit
+          #   The maximum number of resources to return. Defaults to 20. Values are clamped
+          #   between 1 and 100.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer, nil?: true
+
+          # @!attribute order
+          #   Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          #   `desc` for descending order. Defaults to `desc`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::Agents::VaultListParams::Order, nil]
+          optional :order, enum: -> { OpenAI::Beta::Agents::VaultListParams::Order }
+
+          # @!attribute status
+          #   Filter by one status or a list, such as `status=active` or
+          #   `status[]=active&status[]=archived`. Both statuses are included by default.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>, nil]
+          optional :status, union: -> { OpenAI::Beta::Agents::VaultStatusFilter }
+
+          # @!method initialize(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}]
+
+          # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          # `desc` for descending order. Defaults to `desc`.
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            # Returns resources in ascending order.
+            ASC = :asc
+
+            # Returns resources in descending order.
+            DESC = :desc
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vault_retrieve_params.rb

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

data/lib/openai/models/beta/agents/vault_status.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # Whether a vault or credential is active or archived.
+        module VaultStatus
+          extend OpenAI::Internal::Type::Enum
+
+          ACTIVE = :active
+          ARCHIVED = :archived
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vault_status_filter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # One or more lifecycle statuses to include when listing vaults or credentials.
+        module VaultStatusFilter
+          extend OpenAI::Internal::Type::Union
+
+          # Whether a vault or credential is active or archived.
+          variant enum: -> { OpenAI::Beta::Agents::VaultStatus }
+
+          variant -> { OpenAI::Models::Beta::Agents::VaultStatusFilter::VaultStatusArray }
+
+          # @!method self.variants
+          #   @return [Array(Symbol, OpenAI::Models::Beta::Agents::VaultStatus, Array<Symbol, OpenAI::Models::Beta::Agents::VaultStatus>)]
+
+          # @type [OpenAI::Internal::Type::Converter]
+          VaultStatusArray = OpenAI::Internal::Type::ArrayOf[
+            enum: -> { OpenAI::Models::Beta::Agents::VaultStatus }
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Vaults
+          # @see OpenAI::Resources::Beta::Agents::Vaults::Credentials#create
+          class Credential < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The ID of the credential.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute auth
+            #   The authentication method and non-secret configuration for the MCP server.
+            #
+            #   @return [OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::StaticBearer]
+            required :auth, union: -> { OpenAI::Beta::Agents::Vaults::CredentialAuth }
+
+            # @!attribute created_at
+            #   The Unix timestamp, in seconds, when the credential was created.
+            #
+            #   @return [Integer]
+            required :created_at, Integer
+
+            # @!attribute name
+            #   The human-readable name of the credential.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute object
+            #   The object type. Always `vault.credential`.
+            #
+            #   @return [Symbol, :"vault.credential"]
+            required :object, const: :"vault.credential"
+
+            # @!attribute updated_at
+            #   The Unix timestamp, in seconds, when the credential was last updated.
+            #
+            #   @return [Integer]
+            required :updated_at, Integer
+
+            # @!attribute vault_id
+            #   The ID of the vault containing this credential.
+            #
+            #   @return [String]
+            required :vault_id, String
+
+            # @!method initialize(id:, auth:, created_at:, name:, updated_at:, vault_id:, object: :"vault.credential")
+            #   Metadata for a stored MCP server credential. Secret values are never returned.
+            #
+            #   @param id [String]
+            #     The ID of the credential.
+            #
+            #   @param auth [OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::McpOauth, OpenAI::Models::Beta::Agents::Vaults::CredentialAuth::StaticBearer]
+            #     The authentication method and non-secret configuration for the MCP server.
+            #
+            #   @param created_at [Integer]
+            #     The Unix timestamp, in seconds, when the credential was created.
+            #
+            #   @param name [String]
+            #     The human-readable name of the credential.
+            #
+            #   @param updated_at [Integer]
+            #     The Unix timestamp, in seconds, when the credential was last updated.
+            #
+            #   @param vault_id [String]
+            #     The ID of the vault containing this credential.
+            #
+            #   @param object [Symbol, :"vault.credential"]
+            #     The object type. Always `vault.credential`.
+          end
+        end
+      end
+    end
+  end
+end