openai 0.9.0 → 0.11.0

data/rbi/openai/models/webhooks/fine_tuning_job_succeeded_webhook_event.rbi

@@ -0,0 +1,158 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class FineTuningJobSucceededWebhookEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig do
+          returns(OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Data)
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # The type of the event. Always `fine_tuning.job.succeeded`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Object::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # Sent when a fine-tuning job has succeeded.
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            data:
+              OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Data::OrHash,
+            object:
+              OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Object::OrSymbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the event.
+          id:,
+          # The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
+          created_at:,
+          # Event data payload.
+          data:,
+          # The object of the event. Always `event`.
+          object: nil,
+          # The type of the event. Always `fine_tuning.job.succeeded`.
+          type: :"fine_tuning.job.succeeded"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Data,
+              type: Symbol,
+              object:
+                OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Data,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the fine-tuning job.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Event data payload.
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The unique ID of the fine-tuning job.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        # The object of the event. Always `event`.
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/webhooks/response_cancelled_webhook_event.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class ResponseCancelledWebhookEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::ResponseCancelledWebhookEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the model response was cancelled.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig { returns(OpenAI::Webhooks::ResponseCancelledWebhookEvent::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: OpenAI::Webhooks::ResponseCancelledWebhookEvent::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # The type of the event. Always `response.cancelled`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Webhooks::ResponseCancelledWebhookEvent::Object::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Webhooks::ResponseCancelledWebhookEvent::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # Sent when a background response has been cancelled.
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            data: OpenAI::Webhooks::ResponseCancelledWebhookEvent::Data::OrHash,
+            object:
+              OpenAI::Webhooks::ResponseCancelledWebhookEvent::Object::OrSymbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the event.
+          id:,
+          # The Unix timestamp (in seconds) of when the model response was cancelled.
+          created_at:,
+          # Event data payload.
+          data:,
+          # The object of the event. Always `event`.
+          object: nil,
+          # The type of the event. Always `response.cancelled`.
+          type: :"response.cancelled"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::ResponseCancelledWebhookEvent::Data,
+              type: Symbol,
+              object:
+                OpenAI::Webhooks::ResponseCancelledWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Webhooks::ResponseCancelledWebhookEvent::Data,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the model response.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Event data payload.
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The unique ID of the model response.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        # The object of the event. Always `event`.
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Webhooks::ResponseCancelledWebhookEvent::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              OpenAI::Webhooks::ResponseCancelledWebhookEvent::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Webhooks::ResponseCancelledWebhookEvent::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/webhooks/response_completed_webhook_event.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class ResponseCompletedWebhookEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::ResponseCompletedWebhookEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the model response was completed.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig { returns(OpenAI::Webhooks::ResponseCompletedWebhookEvent::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: OpenAI::Webhooks::ResponseCompletedWebhookEvent::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # The type of the event. Always `response.completed`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Webhooks::ResponseCompletedWebhookEvent::Object::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Webhooks::ResponseCompletedWebhookEvent::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # Sent when a background response has been completed.
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            data: OpenAI::Webhooks::ResponseCompletedWebhookEvent::Data::OrHash,
+            object:
+              OpenAI::Webhooks::ResponseCompletedWebhookEvent::Object::OrSymbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the event.
+          id:,
+          # The Unix timestamp (in seconds) of when the model response was completed.
+          created_at:,
+          # Event data payload.
+          data:,
+          # The object of the event. Always `event`.
+          object: nil,
+          # The type of the event. Always `response.completed`.
+          type: :"response.completed"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::ResponseCompletedWebhookEvent::Data,
+              type: Symbol,
+              object:
+                OpenAI::Webhooks::ResponseCompletedWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Webhooks::ResponseCompletedWebhookEvent::Data,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the model response.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Event data payload.
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The unique ID of the model response.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        # The object of the event. Always `event`.
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Webhooks::ResponseCompletedWebhookEvent::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              OpenAI::Webhooks::ResponseCompletedWebhookEvent::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Webhooks::ResponseCompletedWebhookEvent::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/webhooks/response_failed_webhook_event.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class ResponseFailedWebhookEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::ResponseFailedWebhookEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the model response failed.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig { returns(OpenAI::Webhooks::ResponseFailedWebhookEvent::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: OpenAI::Webhooks::ResponseFailedWebhookEvent::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # The type of the event. Always `response.failed`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Webhooks::ResponseFailedWebhookEvent::Object::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Webhooks::ResponseFailedWebhookEvent::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # Sent when a background response has failed.
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            data: OpenAI::Webhooks::ResponseFailedWebhookEvent::Data::OrHash,
+            object:
+              OpenAI::Webhooks::ResponseFailedWebhookEvent::Object::OrSymbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the event.
+          id:,
+          # The Unix timestamp (in seconds) of when the model response failed.
+          created_at:,
+          # Event data payload.
+          data:,
+          # The object of the event. Always `event`.
+          object: nil,
+          # The type of the event. Always `response.failed`.
+          type: :"response.failed"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::ResponseFailedWebhookEvent::Data,
+              type: Symbol,
+              object:
+                OpenAI::Webhooks::ResponseFailedWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Webhooks::ResponseFailedWebhookEvent::Data,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the model response.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Event data payload.
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The unique ID of the model response.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        # The object of the event. Always `event`.
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Webhooks::ResponseFailedWebhookEvent::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              OpenAI::Webhooks::ResponseFailedWebhookEvent::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Webhooks::ResponseFailedWebhookEvent::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end