openai 0.120.0 → 0.121.0

data/rbi/openai/models/beta/agents/automation_update_params.rbi

@@ -0,0 +1,161 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        class AutomationUpdateParams < OpenAI::Internal::Type::BaseModel
+
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::Agents::AutomationUpdateParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig { returns(String) }
+          attr_accessor :automation_id
+
+          # Only accepted for periodic automations.
+          sig { returns(T.nilable(String)) }
+          attr_reader :expression
+
+          sig { params(expression: String).void }
+          attr_writer :expression
+
+          # Replaces all metadata; omit to leave unchanged.
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :metadata
+
+          sig { params(metadata: T::Hash[Symbol, String]).void }
+          attr_writer :metadata
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # A future Unix timestamp in seconds; accepted only before a one-time scheduled
+          # invocation exists.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :run_at
+
+          sig { params(run_at: Integer).void }
+          attr_writer :run_at
+
+          # Replaces the complete target, retaining its type and any creator session.
+          sig {
+            returns(
+              T.nilable(
+                T.any(
+                  OpenAI::Beta::Agents::AutomationTargetParam::NewSession,
+                  OpenAI::Beta::Agents::AutomationTargetParam::ExistingSession
+                )
+              )
+            )
+          }
+          attr_reader :target
+
+          sig {
+            params(
+              target: T.any(
+                OpenAI::Beta::Agents::AutomationTargetParam::NewSession::OrHash,
+                OpenAI::Beta::Agents::AutomationTargetParam::ExistingSession::OrHash
+              )
+            )
+              .void
+          }
+          attr_writer :target
+
+          # Only accepted for periodic automations.
+          sig { returns(T.nilable(String)) }
+          attr_reader :timezone
+
+          sig { params(timezone: String).void }
+          attr_writer :timezone
+
+          sig do
+            params(
+
+              automation_id: String,
+
+              expression: String,
+
+              metadata: T::Hash[Symbol, String],
+
+              name: String,
+
+              run_at: Integer,
+
+              target: T.any(
+                OpenAI::Beta::Agents::AutomationTargetParam::NewSession::OrHash,
+                OpenAI::Beta::Agents::AutomationTargetParam::ExistingSession::OrHash
+              ),
+
+              timezone: String,
+
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            automation_id:,
+
+            # Only accepted for periodic automations.
+            expression: nil,
+
+            # Replaces all metadata; omit to leave unchanged.
+            metadata: nil,
+
+            name: nil,
+
+            # A future Unix timestamp in seconds; accepted only before a one-time scheduled
+            # invocation exists.
+            run_at: nil,
+
+            # Replaces the complete target, retaining its type and any creator session.
+            target: nil,
+
+            # Only accepted for periodic automations.
+            timezone: nil,
+
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                automation_id: String,
+                expression: String,
+                metadata: T::Hash[Symbol, String],
+                name: String,
+                run_at: Integer,
+                target: T.any(
+                  OpenAI::Beta::Agents::AutomationTargetParam::NewSession,
+                  OpenAI::Beta::Agents::AutomationTargetParam::ExistingSession
+                ),
+                timezone: String,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agents/automations/automation_invocation.rbi

@@ -0,0 +1,233 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        AutomationInvocation = Automations::AutomationInvocation
+
+        module Automations
+
+          class AutomationInvocation < OpenAI::Internal::Type::BaseModel
+
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::Automations::AutomationInvocation,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The invocation ID.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # The automation that owns the invocation.
+            sig { returns(String) }
+            attr_accessor :automation_id
+
+            # The creation time as a Unix timestamp in seconds.
+            sig { returns(Integer) }
+            attr_accessor :created_at
+
+            # The permanent delivery failure, or null when no failure occurred.
+            sig { returns(T.nilable(OpenAI::Beta::Agents::Automations::AutomationInvocation::Error)) }
+            attr_reader :error
+
+            sig {
+              params(error: T.nilable(OpenAI::Beta::Agents::Automations::AutomationInvocation::Error::OrHash)).void
+            }
+            attr_writer :error
+
+            # Always `agent.automation.invocation`.
+            sig { returns(Symbol) }
+            attr_accessor :object
+
+            # The intended occurrence as a Unix timestamp in seconds, or null for manual runs.
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :scheduled_at
+
+            # The target or newly created session ID, or null before one is available.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :session_id
+
+            # Why an occurrence was skipped, or null when it was not skipped.
+            sig { returns(T.nilable(Symbol)) }
+            attr_accessor :skip_reason
+
+            # Whether the invocation was manual or scheduled.
+            sig { returns(OpenAI::Beta::Agents::Automations::AutomationInvocationSource::Variants) }
+            attr_accessor :source
+
+            # Delivery status; completed does not mean the agent's work has finished.
+            sig { returns(OpenAI::Beta::Agents::Automations::AutomationInvocation::Status::TaggedSymbol) }
+            attr_accessor :status
+
+            # One attempted delivery by an automation.
+            sig do
+              params(
+
+                id: String,
+
+                automation_id: String,
+
+                created_at: Integer,
+
+                error: T.nilable(OpenAI::Beta::Agents::Automations::AutomationInvocation::Error::OrHash),
+
+                scheduled_at: T.nilable(Integer),
+
+                session_id: T.nilable(String),
+
+                source: T.any(
+                  OpenAI::Beta::Agents::Automations::AutomationInvocationSource::Manual::OrHash,
+                  OpenAI::Beta::Agents::Automations::AutomationInvocationSource::Automation::OrHash
+                ),
+
+                status: OpenAI::Beta::Agents::Automations::AutomationInvocation::Status::OrSymbol,
+
+                object: Symbol,
+
+                skip_reason: T.nilable(Symbol)
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The invocation ID.
+              id:,
+
+              # The automation that owns the invocation.
+              automation_id:,
+
+              # The creation time as a Unix timestamp in seconds.
+              created_at:,
+
+              # The permanent delivery failure, or null when no failure occurred.
+              error:,
+
+              # The intended occurrence as a Unix timestamp in seconds, or null for manual runs.
+              scheduled_at:,
+
+              # The target or newly created session ID, or null before one is available.
+              session_id:,
+
+              # Whether the invocation was manual or scheduled.
+              source:,
+
+              # Delivery status; completed does not mean the agent's work has finished.
+              status:,
+
+              # Always `agent.automation.invocation`.
+              object: :"agent.automation.invocation",
+
+              # Why an occurrence was skipped, or null when it was not skipped.
+
+              skip_reason: :pending_delivery
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  automation_id: String,
+                  created_at: Integer,
+                  error: T.nilable(OpenAI::Beta::Agents::Automations::AutomationInvocation::Error),
+                  object: Symbol,
+                  scheduled_at: T.nilable(Integer),
+                  session_id: T.nilable(String),
+                  skip_reason: T.nilable(Symbol),
+                  source: OpenAI::Beta::Agents::Automations::AutomationInvocationSource::Variants,
+                  status: OpenAI::Beta::Agents::Automations::AutomationInvocation::Status::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Error < OpenAI::Internal::Type::BaseModel
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Beta::Agents::Automations::AutomationInvocation::Error,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              # A machine-readable error code.
+              sig { returns(String) }
+              attr_accessor :code
+
+              # A public explanation of the delivery failure.
+              sig { returns(String) }
+              attr_accessor :message
+
+              # The permanent delivery failure, or null when no failure occurred.
+              sig do
+                params(
+
+                  code: String,
+
+                  message: String
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                # A machine-readable error code.
+                code:,
+
+                # A public explanation of the delivery failure.
+
+                message:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {code: String, message: String}
+                )
+              end
+              def to_hash
+              end
+
+            end
+
+            # Delivery status; completed does not mean the agent's work has finished.
+            module Status
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol = T.type_alias {
+                T.all(Symbol, OpenAI::Beta::Agents::Automations::AutomationInvocation::Status)
+              }
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              QUEUED = T.let(:queued, OpenAI::Beta::Agents::Automations::AutomationInvocation::Status::TaggedSymbol)
+              COMPLETED = T.let(
+                :completed,
+                OpenAI::Beta::Agents::Automations::AutomationInvocation::Status::TaggedSymbol
+              )
+              FAILED = T.let(:failed, OpenAI::Beta::Agents::Automations::AutomationInvocation::Status::TaggedSymbol)
+              SKIPPED = T.let(:skipped, OpenAI::Beta::Agents::Automations::AutomationInvocation::Status::TaggedSymbol)
+
+              sig {
+                override.returns(
+                  T::Array[OpenAI::Beta::Agents::Automations::AutomationInvocation::Status::TaggedSymbol]
+                )
+              }
+              def self.values
+              end
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agents/automations/automation_invocation_source.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        AutomationInvocationSource = Automations::AutomationInvocationSource
+
+        module Automations
+
+          module AutomationInvocationSource
+            extend OpenAI::Internal::Type::Union
+
+            Variants = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::Automations::AutomationInvocationSource::Manual,
+                OpenAI::Beta::Agents::Automations::AutomationInvocationSource::Automation
+              )
+            end
+
+            class Manual < OpenAI::Internal::Type::BaseModel
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Beta::Agents::Automations::AutomationInvocationSource::Manual,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              # The type of the object. Always `manual`.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              sig do
+                params(
+
+                  type: Symbol
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                # The type of the object. Always `manual`.
+
+                type: :manual
+              )
+              end
+
+              sig do
+                override.returns(
+                  {type: Symbol}
+                )
+              end
+              def to_hash
+              end
+
+            end
+
+            class Automation < OpenAI::Internal::Type::BaseModel
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Beta::Agents::Automations::AutomationInvocationSource::Automation,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              # The automation snapshot for this occurrence, excluding confidential values.
+              sig { returns(OpenAI::Beta::Agents::Automation::Variants) }
+              attr_accessor :automation
+
+              # The type of the object. Always `automation`.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              sig do
+                params(
+
+                  automation: T.any(
+                    OpenAI::Beta::Agents::PeriodicAutomation::OrHash,
+                    OpenAI::Beta::Agents::OneTimeAutomation::OrHash
+                  ),
+
+                  type: Symbol
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                # The automation snapshot for this occurrence, excluding confidential values.
+                automation:,
+
+                # The type of the object. Always `automation`.
+
+                type: :automation
+              )
+              end
+
+              sig do
+                override.returns(
+                  {automation: OpenAI::Beta::Agents::Automation::Variants, type: Symbol}
+                )
+              end
+              def to_hash
+              end
+
+            end
+
+            sig { override.returns(T::Array[OpenAI::Beta::Agents::Automations::AutomationInvocationSource::Variants]) }
+            def self.variants
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agents/automations/invocation_create_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        module Automations
+
+          class InvocationCreateParams < OpenAI::Internal::Type::BaseModel
+
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::Automations::InvocationCreateParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            sig { returns(String) }
+            attr_accessor :automation_id
+
+            sig do
+              params(
+
+                automation_id: String,
+
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              automation_id:,
+
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {automation_id: String, request_options: OpenAI::RequestOptions}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agents/automations/invocation_list_params.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        module Automations
+
+          class InvocationListParams < OpenAI::Internal::Type::BaseModel
+
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::Automations::InvocationListParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            sig { returns(String) }
+            attr_accessor :automation_id
+
+            # Return resources after this resource ID in the selected order.
+            sig { returns(T.nilable(String)) }
+            attr_reader :after
+
+            sig { params(after: String).void }
+            attr_writer :after
+
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :limit
+
+            sig { params(limit: Integer).void }
+            attr_writer :limit
+
+            # The order in which resources are returned. Defaults to `desc`.
+            sig { returns(T.nilable(OpenAI::Beta::Agents::Automations::InvocationListParams::Order::OrSymbol)) }
+            attr_reader :order
+
+            sig { params(order: OpenAI::Beta::Agents::Automations::InvocationListParams::Order::OrSymbol).void }
+            attr_writer :order
+
+            sig do
+              params(
+
+                automation_id: String,
+
+                after: String,
+
+                limit: Integer,
+
+                order: OpenAI::Beta::Agents::Automations::InvocationListParams::Order::OrSymbol,
+
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              automation_id:,
+
+              # Return resources after this resource ID in the selected order.
+              after: nil,
+
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              limit: nil,
+
+              # The order in which resources are returned. Defaults to `desc`.
+              order: nil,
+
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  automation_id: String,
+                  after: String,
+                  limit: Integer,
+                  order: OpenAI::Beta::Agents::Automations::InvocationListParams::Order::OrSymbol,
+                  request_options: OpenAI::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The order in which resources are returned. Defaults to `desc`.
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol = T.type_alias {
+                T.all(Symbol, OpenAI::Beta::Agents::Automations::InvocationListParams::Order)
+              }
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              # Returns resources in ascending order.
+              ASC = T.let(:asc, OpenAI::Beta::Agents::Automations::InvocationListParams::Order::TaggedSymbol)
+
+              # Returns resources in descending order.
+              DESC = T.let(:desc, OpenAI::Beta::Agents::Automations::InvocationListParams::Order::TaggedSymbol)
+
+              sig {
+                override.returns(T::Array[OpenAI::Beta::Agents::Automations::InvocationListParams::Order::TaggedSymbol])
+              }
+              def self.values
+              end
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end