openai 0.89.0 → 0.90.0

data/lib/openai/models/beta/environment_param.rb

@@ -0,0 +1,269 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The execution environment and optional reusable template for a session.
+      module EnvironmentParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Runs the agent without an execution environment.
+        variant :none, -> { OpenAI::Beta::EnvironmentParam::None }
+
+        # An OpenAI-hosted environment, optionally based on a reusable template.
+        variant :openai_hosted, -> { OpenAI::Beta::EnvironmentParam::OpenAIHosted }
+
+        # An application-hosted environment configured inline.
+        variant :self_hosted, -> { OpenAI::Beta::EnvironmentParam::SelfHosted }
+
+        class None < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `none`.
+          #
+          #   @return [Symbol, :none]
+          required :type, const: :none
+
+          # @!method initialize(type: :none)
+          #   Runs the agent without an execution environment.
+          #
+          #   @param type [Symbol, :none]
+          #     The type of the object. Always `none`.
+        end
+
+        class OpenAIHosted < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `openai_hosted`.
+          #
+          #   @return [Symbol, :openai_hosted]
+          required :type, const: :openai_hosted
+
+          # @!attribute capability_directories
+          #   Directories that contain capabilities exposed to the agent. Defaults to an empty
+          #   list.
+          #
+          #   @return [Array<String>, nil]
+          optional :capability_directories, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute env
+          #   Environment variables made available to the agent.
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :env, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+          # @!attribute environment_template_id
+          #   A reusable hosted template applied before inline session configuration. Omitted
+          #   fields inherit the template; network overrides cannot broaden its policy.
+          #
+          #   @return [String, nil]
+          optional :environment_template_id, String
+
+          # @!attribute files
+          #   Files available before the agent starts. Defaults to an empty list.
+          #
+          #   @return [Array<OpenAI::Models::Beta::HostedEnvironmentFileParam::FileID, OpenAI::Models::Beta::HostedEnvironmentFileParam::Inline>, nil]
+          optional(
+            :files,
+            -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::HostedEnvironmentFileParam] },
+            nil?: true
+          )
+
+          # @!attribute network
+          #   Network access for an OpenAI-hosted environment.
+          #
+          #   @return [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network, nil]
+          optional :network, -> { OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network }, nil?: true
+
+          # @!attribute packages
+          #   Packages to install in an OpenAI-hosted environment.
+          #
+          #   @return [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Packages, nil]
+          optional :packages, -> { OpenAI::Beta::EnvironmentParam::OpenAIHosted::Packages }, nil?: true
+
+          # @!attribute plugins
+          #   Plugins provided as inline ZIP archives. Defaults to an empty list.
+          #
+          #   @return [Array<OpenAI::Models::Beta::HostedPluginParam>, nil]
+          optional(
+            :plugins,
+            -> {
+              OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::HostedPluginParam]
+            },
+            nil?: true
+          )
+
+          # @!attribute setup_commands
+          #   Ordered, confidential setup commands. Command bodies are never returned.
+          #
+          #   @return [Array<OpenAI::Models::Beta::SetupCommandParam>, nil]
+          optional(
+            :setup_commands,
+            -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::SetupCommandParam] },
+            nil?: true
+          )
+
+          # @!attribute skills
+          #   Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty
+          #   list.
+          #
+          #   @return [Array<OpenAI::Models::Beta::HostedSkillParam::SkillReference, OpenAI::Models::Beta::HostedSkillParam::Inline>, nil]
+          optional(
+            :skills,
+            -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::HostedSkillParam] },
+            nil?: true
+          )
+
+          # @!method initialize(capability_directories: nil, env: nil, environment_template_id: nil, files: nil, network: nil, packages: nil, plugins: nil, setup_commands: nil, skills: nil, type: :openai_hosted)
+          #   An OpenAI-hosted environment, optionally based on a reusable template.
+          #
+          #   @param capability_directories [Array<String>, nil]
+          #     Directories that contain capabilities exposed to the agent. Defaults to an empty
+          #     list.
+          #
+          #   @param env [Hash{Symbol=>String}, nil]
+          #     Environment variables made available to the agent.
+          #
+          #   @param environment_template_id [String]
+          #     A reusable hosted template applied before inline session configuration. Omitted
+          #     fields inherit the template; network overrides cannot broaden its policy.
+          #
+          #   @param files [Array<OpenAI::Models::Beta::HostedEnvironmentFileParam::FileID, OpenAI::Models::Beta::HostedEnvironmentFileParam::Inline>, nil]
+          #     Files available before the agent starts. Defaults to an empty list.
+          #
+          #   @param network [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network, nil]
+          #     Network access for an OpenAI-hosted environment.
+          #
+          #   @param packages [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Packages, nil]
+          #     Packages to install in an OpenAI-hosted environment.
+          #
+          #   @param plugins [Array<OpenAI::Models::Beta::HostedPluginParam>, nil]
+          #     Plugins provided as inline ZIP archives. Defaults to an empty list.
+          #
+          #   @param setup_commands [Array<OpenAI::Models::Beta::SetupCommandParam>, nil]
+          #     Ordered, confidential setup commands. Command bodies are never returned.
+          #
+          #   @param skills [Array<OpenAI::Models::Beta::HostedSkillParam::SkillReference, OpenAI::Models::Beta::HostedSkillParam::Inline>, nil]
+          #     Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty
+          #     list.
+          #
+          #   @param type [Symbol, :openai_hosted]
+          #     The type of the object. Always `openai_hosted`.
+
+          # @see OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted#network
+          class Network < OpenAI::Internal::Type::BaseModel
+            # @!attribute access
+            #   The environment's network access mode.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network::Access]
+            required :access, enum: -> { OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network::Access }
+
+            # @!attribute allowed_domains
+            #   Domains the environment may access when network access is restricted.
+            #
+            #   @return [Array<String>, nil]
+            optional :allowed_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+            # @!method initialize(access:, allowed_domains: nil)
+            #   Network access for an OpenAI-hosted environment.
+            #
+            #   @param access [Symbol, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network::Access]
+            #     The environment's network access mode.
+            #
+            #   @param allowed_domains [Array<String>, nil]
+            #     Domains the environment may access when network access is restricted.
+
+            # The environment's network access mode.
+            #
+            # @see OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network#access
+            module Access
+              extend OpenAI::Internal::Type::Enum
+
+              # Allows unrestricted network access, matching an omitted network policy.
+              ENABLED = :enabled
+
+              # Disables network access.
+              DISABLED = :disabled
+
+              # Allows access only to configured domains.
+              RESTRICTED = :restricted
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted#packages
+          class Packages < OpenAI::Internal::Type::BaseModel
+            # @!attribute npm
+            #   npm packages to install globally. Defaults to an empty list.
+            #
+            #   @return [Array<String>, nil]
+            optional :npm, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+            # @!attribute python
+            #   Python packages to install. Defaults to an empty list.
+            #
+            #   @return [Array<String>, nil]
+            optional :python, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+            # @!attribute system_
+            #   System packages to install. Defaults to an empty list.
+            #
+            #   @return [Array<String>, nil]
+            optional :system_, OpenAI::Internal::Type::ArrayOf[String], api_name: :system, nil?: true
+
+            # @!method initialize(npm: nil, python: nil, system_: nil)
+            #   Packages to install in an OpenAI-hosted environment.
+            #
+            #   @param npm [Array<String>, nil]
+            #     npm packages to install globally. Defaults to an empty list.
+            #
+            #   @param python [Array<String>, nil]
+            #     Python packages to install. Defaults to an empty list.
+            #
+            #   @param system_ [Array<String>, nil]
+            #     System packages to install. Defaults to an empty list.
+          end
+        end
+
+        class SelfHosted < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `self_hosted`.
+          #
+          #   @return [Symbol, :self_hosted]
+          required :type, const: :self_hosted
+
+          # @!attribute workspace_directory
+          #   Absolute project directory inside the self-hosted environment.
+          #
+          #   @return [String]
+          required :workspace_directory, String
+
+          # @!attribute capability_directories
+          #   Directories that contain capabilities exposed to the agent. Defaults to an empty
+          #   list.
+          #
+          #   @return [Array<String>, nil]
+          optional :capability_directories, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!method initialize(workspace_directory:, capability_directories: nil, type: :self_hosted)
+          #   An application-hosted environment configured inline.
+          #
+          #   @param workspace_directory [String]
+          #     Absolute project directory inside the self-hosted environment.
+          #
+          #   @param capability_directories [Array<String>, nil]
+          #     Directories that contain capabilities exposed to the agent. Defaults to an empty
+          #     list.
+          #
+          #   @param type [Symbol, :self_hosted]
+          #     The type of the object. Always `self_hosted`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::EnvironmentParam::None, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted, OpenAI::Models::Beta::EnvironmentParam::SelfHosted)]
+      end
+    end
+  end
+end

data/lib/openai/models/beta/hosted_environment_file.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # Metadata for a file materialized in an OpenAI-hosted execution environment.
+      module HostedEnvironmentFile
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A file copied from the OpenAI Files API.
+        variant :file_id, -> { OpenAI::Beta::HostedEnvironmentFileID }
+
+        # A file supplied inline when the session was created.
+        variant :inline, -> { OpenAI::Beta::HostedEnvironmentFile::Inline }
+
+        class Inline < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The session-scoped ID of the file in the execution environment.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute path
+          #   The file's absolute path inside the environment.
+          #
+          #   @return [String]
+          required :path, String
+
+          # @!attribute size_bytes
+          #   The decoded file size in bytes.
+          #
+          #   @return [Integer]
+          required :size_bytes, Integer
+
+          # @!attribute type
+          #   The type of the object. Always `inline`.
+          #
+          #   @return [Symbol, :inline]
+          required :type, const: :inline
+
+          # @!method initialize(id:, path:, size_bytes:, type: :inline)
+          #   A file supplied inline when the session was created.
+          #
+          #   @param id [String]
+          #     The session-scoped ID of the file in the execution environment.
+          #
+          #   @param path [String]
+          #     The file's absolute path inside the environment.
+          #
+          #   @param size_bytes [Integer]
+          #     The decoded file size in bytes.
+          #
+          #   @param type [Symbol, :inline]
+          #     The type of the object. Always `inline`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::HostedEnvironmentFileID, OpenAI::Models::Beta::HostedEnvironmentFile::Inline)]
+      end
+    end
+  end
+end

data/lib/openai/models/beta/hosted_environment_file_id.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class HostedEnvironmentFileID < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The session-scoped ID of the file in the execution environment.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute file_id
+        #   The ID of the uploaded file.
+        #
+        #   @return [String]
+        required :file_id, String
+
+        # @!attribute path
+        #   The file's absolute path inside the environment.
+        #
+        #   @return [String]
+        required :path, String
+
+        # @!attribute size_bytes
+        #   The decoded file size in bytes.
+        #
+        #   @return [Integer]
+        required :size_bytes, Integer
+
+        # @!attribute type
+        #   The type of the object. Always `file_id`.
+        #
+        #   @return [Symbol, :file_id]
+        required :type, const: :file_id
+
+        # @!method initialize(id:, file_id:, path:, size_bytes:, type: :file_id)
+        #   A file copied from the OpenAI Files API.
+        #
+        #   @param id [String]
+        #     The session-scoped ID of the file in the execution environment.
+        #
+        #   @param file_id [String]
+        #     The ID of the uploaded file.
+        #
+        #   @param path [String]
+        #     The file's absolute path inside the environment.
+        #
+        #   @param size_bytes [Integer]
+        #     The decoded file size in bytes.
+        #
+        #   @param type [Symbol, :file_id]
+        #     The type of the object. Always `file_id`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/hosted_environment_file_param.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A file materialized in an OpenAI-hosted execution environment.
+      module HostedEnvironmentFileParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A file previously uploaded through the OpenAI Files API.
+        variant :file_id, -> { OpenAI::Beta::HostedEnvironmentFileParam::FileID }
+
+        # A file supplied directly as standard-base64 data.
+        variant :inline, -> { OpenAI::Beta::HostedEnvironmentFileParam::Inline }
+
+        class FileID < OpenAI::Internal::Type::BaseModel
+          # @!attribute file_id
+          #   The ID of the uploaded file.
+          #
+          #   @return [String]
+          required :file_id, String
+
+          # @!attribute path
+          #   The absolute destination path inside `/workspace`.
+          #
+          #   @return [String]
+          required :path, String
+
+          # @!attribute type
+          #   The type of the object. Always `file_id`.
+          #
+          #   @return [Symbol, :file_id]
+          required :type, const: :file_id
+
+          # @!method initialize(file_id:, path:, type: :file_id)
+          #   A file previously uploaded through the OpenAI Files API.
+          #
+          #   @param file_id [String]
+          #     The ID of the uploaded file.
+          #
+          #   @param path [String]
+          #     The absolute destination path inside `/workspace`.
+          #
+          #   @param type [Symbol, :file_id]
+          #     The type of the object. Always `file_id`.
+        end
+
+        class Inline < OpenAI::Internal::Type::BaseModel
+          # @!attribute data
+          #   The standard-base64-encoded file contents.
+          #
+          #   @return [String]
+          required :data, String
+
+          # @!attribute path
+          #   The absolute destination path inside `/workspace`.
+          #
+          #   @return [String]
+          required :path, String
+
+          # @!attribute type
+          #   The type of the object. Always `inline`.
+          #
+          #   @return [Symbol, :inline]
+          required :type, const: :inline
+
+          # @!method initialize(data:, path:, type: :inline)
+          #   A file supplied directly as standard-base64 data.
+          #
+          #   @param data [String]
+          #     The standard-base64-encoded file contents.
+          #
+          #   @param path [String]
+          #     The absolute destination path inside `/workspace`.
+          #
+          #   @param type [Symbol, :inline]
+          #     The type of the object. Always `inline`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::HostedEnvironmentFileParam::FileID, OpenAI::Models::Beta::HostedEnvironmentFileParam::Inline)]
+      end
+    end
+  end
+end

data/lib/openai/models/beta/hosted_plugin.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class HostedPlugin < OpenAI::Internal::Type::BaseModel
+        # @!attribute description
+        #   The installed plugin description.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute name
+        #   The installed plugin name.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   The type of the object. Always `inline`.
+        #
+        #   @return [Symbol, :inline]
+        required :type, const: :inline
+
+        # @!method initialize(description:, name:, type: :inline)
+        #   A plugin installed from an inline ZIP archive.
+        #
+        #   @param description [String]
+        #     The installed plugin description.
+        #
+        #   @param name [String]
+        #     The installed plugin name.
+        #
+        #   @param type [Symbol, :inline]
+        #     The type of the object. Always `inline`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/hosted_plugin_param.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class HostedPluginParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute description
+        #   The plugin description declared in `.codex-plugin/plugin.json`.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute name
+        #   The plugin name declared in `.codex-plugin/plugin.json`.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute source
+        #   Provides ZIP bytes encoded with standard base64.
+        #
+        #   @return [OpenAI::Models::Beta::InlineCapabilitySourceParam]
+        required :source, -> { OpenAI::Beta::InlineCapabilitySourceParam }
+
+        # @!attribute type
+        #   The type of the object. Always `inline`.
+        #
+        #   @return [Symbol, :inline]
+        required :type, const: :inline
+
+        # @!method initialize(description:, name:, source:, type: :inline)
+        #   Supplies a plugin ZIP directly in the session request.
+        #
+        #   @param description [String]
+        #     The plugin description declared in `.codex-plugin/plugin.json`.
+        #
+        #   @param name [String]
+        #     The plugin name declared in `.codex-plugin/plugin.json`.
+        #
+        #   @param source [OpenAI::Models::Beta::InlineCapabilitySourceParam]
+        #     Provides ZIP bytes encoded with standard base64.
+        #
+        #   @param type [Symbol, :inline]
+        #     The type of the object. Always `inline`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/hosted_skill.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A skill installed in an OpenAI-hosted environment.
+      module HostedSkill
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A skill installed from the Skills API.
+        variant :skill_reference, -> { OpenAI::Beta::HostedSkillReference }
+
+        # A skill installed from an inline ZIP archive.
+        variant :inline, -> { OpenAI::Beta::HostedSkill::Inline }
+
+        class Inline < OpenAI::Internal::Type::BaseModel
+          # @!attribute description
+          #   The installed skill description.
+          #
+          #   @return [String]
+          required :description, String
+
+          # @!attribute name
+          #   The installed skill name.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute type
+          #   The type of the object. Always `inline`.
+          #
+          #   @return [Symbol, :inline]
+          required :type, const: :inline
+
+          # @!method initialize(description:, name:, type: :inline)
+          #   A skill installed from an inline ZIP archive.
+          #
+          #   @param description [String]
+          #     The installed skill description.
+          #
+          #   @param name [String]
+          #     The installed skill name.
+          #
+          #   @param type [Symbol, :inline]
+          #     The type of the object. Always `inline`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::HostedSkillReference, OpenAI::Models::Beta::HostedSkill::Inline)]
+      end
+    end
+  end
+end