openai 0.10.0 → 0.11.0

data/rbi/openai/models/webhooks/batch_cancelled_webhook_event.rbi

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

data/rbi/openai/models/webhooks/batch_completed_webhook_event.rbi

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

data/rbi/openai/models/webhooks/batch_expired_webhook_event.rbi

@@ -0,0 +1,150 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class BatchExpiredWebhookEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::BatchExpiredWebhookEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the batch API request expired.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig { returns(OpenAI::Webhooks::BatchExpiredWebhookEvent::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: OpenAI::Webhooks::BatchExpiredWebhookEvent::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # The type of the event. Always `batch.expired`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Webhooks::BatchExpiredWebhookEvent::Object::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object: OpenAI::Webhooks::BatchExpiredWebhookEvent::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # Sent when a batch API request has expired.
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            data: OpenAI::Webhooks::BatchExpiredWebhookEvent::Data::OrHash,
+            object:
+              OpenAI::Webhooks::BatchExpiredWebhookEvent::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 batch API request expired.
+          created_at:,
+          # Event data payload.
+          data:,
+          # The object of the event. Always `event`.
+          object: nil,
+          # The type of the event. Always `batch.expired`.
+          type: :"batch.expired"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::BatchExpiredWebhookEvent::Data,
+              type: Symbol,
+              object:
+                OpenAI::Webhooks::BatchExpiredWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Webhooks::BatchExpiredWebhookEvent::Data,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the batch API request.
+          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 batch API request.
+            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::BatchExpiredWebhookEvent::Object)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              OpenAI::Webhooks::BatchExpiredWebhookEvent::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Webhooks::BatchExpiredWebhookEvent::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/webhooks/batch_failed_webhook_event.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class BatchFailedWebhookEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::BatchFailedWebhookEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the batch API request failed.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig { returns(OpenAI::Webhooks::BatchFailedWebhookEvent::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: OpenAI::Webhooks::BatchFailedWebhookEvent::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # The type of the event. Always `batch.failed`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Webhooks::BatchFailedWebhookEvent::Object::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object: OpenAI::Webhooks::BatchFailedWebhookEvent::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # Sent when a batch API request has failed.
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            data: OpenAI::Webhooks::BatchFailedWebhookEvent::Data::OrHash,
+            object: OpenAI::Webhooks::BatchFailedWebhookEvent::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 batch API request failed.
+          created_at:,
+          # Event data payload.
+          data:,
+          # The object of the event. Always `event`.
+          object: nil,
+          # The type of the event. Always `batch.failed`.
+          type: :"batch.failed"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::BatchFailedWebhookEvent::Data,
+              type: Symbol,
+              object:
+                OpenAI::Webhooks::BatchFailedWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Webhooks::BatchFailedWebhookEvent::Data,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the batch API request.
+          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 batch API request.
+            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::BatchFailedWebhookEvent::Object)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              OpenAI::Webhooks::BatchFailedWebhookEvent::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Webhooks::BatchFailedWebhookEvent::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end