openai 0.91.0 → 0.92.0

data/rbi/openai/models/webhooks/webhook_update_params.rbi

@@ -0,0 +1,156 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Webhooks
+
+      class WebhookUpdateParams < OpenAI::Internal::Type::BaseModel
+
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Webhooks::WebhookUpdateParams,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        sig { returns(String) }
+        attr_accessor :webhook_endpoint_id
+
+        # The complete set of event types that should trigger deliveries.
+        sig { returns(T.nilable(T::Array[OpenAI::Webhooks::WebhookUpdateParams::EventType::OrSymbol])) }
+        attr_reader :event_types
+
+        sig { params(event_types: T::Array[OpenAI::Webhooks::WebhookUpdateParams::EventType::OrSymbol]).void }
+        attr_writer :event_types
+
+        # A new human-readable name for the webhook endpoint.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # A new HTTPS URL that receives webhook deliveries.
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        sig do
+          params(
+
+            webhook_endpoint_id: String,
+
+            event_types: T::Array[OpenAI::Webhooks::WebhookUpdateParams::EventType::OrSymbol],
+
+            name: String,
+
+            url: String,
+
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          webhook_endpoint_id:,
+
+          # The complete set of event types that should trigger deliveries.
+          event_types: nil,
+
+          # A new human-readable name for the webhook endpoint.
+          name: nil,
+
+          # A new HTTPS URL that receives webhook deliveries.
+          url: nil,
+
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              webhook_endpoint_id: String,
+              event_types: T::Array[OpenAI::Webhooks::WebhookUpdateParams::EventType::OrSymbol],
+              name: String,
+              url: String,
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The event type to send as a sample delivery.
+        module EventType
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Webhooks::WebhookUpdateParams::EventType) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BATCH_COMPLETED = T.let(:"batch.completed", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
+          BATCH_FAILED = T.let(:"batch.failed", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
+          BATCH_EXPIRED = T.let(:"batch.expired", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
+          BATCH_CANCELLED = T.let(:"batch.cancelled", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
+          RESPONSE_COMPLETED = T.let(
+            :"response.completed",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          RESPONSE_FAILED = T.let(:"response.failed", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
+          RESPONSE_CANCELLED = T.let(
+            :"response.cancelled",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          RESPONSE_INCOMPLETE = T.let(
+            :"response.incomplete",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          EVAL_RUN_SUCCEEDED = T.let(
+            :"eval.run.succeeded",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          EVAL_RUN_FAILED = T.let(:"eval.run.failed", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
+          EVAL_RUN_CANCELED = T.let(
+            :"eval.run.canceled",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          FINE_TUNING_JOB_SUCCEEDED = T.let(
+            :"fine_tuning.job.succeeded",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          FINE_TUNING_JOB_FAILED = T.let(
+            :"fine_tuning.job.failed",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          FINE_TUNING_JOB_CANCELLED = T.let(
+            :"fine_tuning.job.cancelled",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          REALTIME_CALL_INCOMING = T.let(
+            :"realtime.call.incoming",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          VIDEO_COMPLETED = T.let(:"video.completed", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
+          VIDEO_FAILED = T.let(:"video.failed", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
+          SAFETY_ALERT_CREATED = T.let(
+            :"safety.alert.created",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+
+          sig { override.returns(T::Array[OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/webhooks/event_types.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Webhooks
+
+      class EventTypes
+
+        # Returns webhook event types visible to the authenticated project.
+        sig { params(request_options: OpenAI::RequestOptions::OrHash).returns(OpenAI::Webhooks::WebhookEventTypeList) }
+        def list(request_options: {})
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/webhooks.rbi

@@ -5,6 +5,132 @@ module OpenAI
 
     class Webhooks
 
+      sig { returns(OpenAI::Resources::Webhooks::EventTypes) }
+      attr_reader :event_types
+
+      # Creates a webhook endpoint for the authenticated project.
+      sig {
+        params(
+          event_types: T::Array[OpenAI::Webhooks::WebhookCreateParams::EventType::OrSymbol],
+          name: String,
+          url: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        )
+          .returns(OpenAI::Webhooks::WebhookEndpointWithSecret)
+      }
+      def create(
+        # The event types that trigger deliveries to this endpoint.
+        event_types:,
+        # A human-readable name for the webhook endpoint.
+        name:,
+        # The HTTPS URL that receives webhook deliveries.
+        url:,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a webhook endpoint for the authenticated project.
+      sig {
+        params(webhook_endpoint_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+          OpenAI::Webhooks::WebhookEndpoint
+        )
+      }
+      def retrieve(
+        # The ID of the webhook endpoint to retrieve.
+        webhook_endpoint_id,
+        request_options: {}
+      )
+      end
+
+      # Updates a webhook endpoint for the authenticated project.
+      sig {
+        params(
+          webhook_endpoint_id: String,
+          event_types: T::Array[OpenAI::Webhooks::WebhookUpdateParams::EventType::OrSymbol],
+          name: String,
+          url: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        )
+          .returns(OpenAI::Webhooks::WebhookEndpoint)
+      }
+      def update(
+        # The ID of the webhook endpoint to update.
+        webhook_endpoint_id,
+        # The complete set of event types that should trigger deliveries.
+        event_types: nil,
+        # A new human-readable name for the webhook endpoint.
+        name: nil,
+        # A new HTTPS URL that receives webhook deliveries.
+        url: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns webhook endpoints for the authenticated project in newest-first order.
+      sig {
+        params(after: T.nilable(String), limit: Integer, request_options: OpenAI::RequestOptions::OrHash).returns(
+          OpenAI::Internal::CursorPage[OpenAI::Webhooks::WebhookEndpoint]
+        )
+      }
+      def list(
+        # ID of the last webhook endpoint from the previous page.
+        after: nil,
+        # Maximum number of webhook endpoints to return. Defaults to 20.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Deletes a webhook endpoint for the authenticated project.
+      sig {
+        params(webhook_endpoint_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+          OpenAI::Webhooks::DeletedWebhookEndpoint
+        )
+      }
+      def delete(
+        # The ID of the webhook endpoint to delete.
+        webhook_endpoint_id,
+        request_options: {}
+      )
+      end
+
+      # Rotates the signing secret for a webhook endpoint in the authenticated project.
+      sig {
+        params(
+          webhook_endpoint_id: String,
+          keep_old_secret_active_for_24_hours: T::Boolean,
+          request_options: OpenAI::RequestOptions::OrHash
+        )
+          .returns(OpenAI::Webhooks::WebhookEndpointWithSecret)
+      }
+      def rotate_secret(
+        # The ID of the webhook endpoint whose signing secret will be rotated.
+        webhook_endpoint_id,
+        # Whether to keep the previous signing secret valid for 24 hours after rotation.
+        # Defaults to false, which invalidates the previous secret immediately.
+        keep_old_secret_active_for_24_hours: nil,
+        request_options: {}
+      )
+      end
+
+      # Sends a sample event to a webhook endpoint for the authenticated project.
+      sig {
+        params(
+          webhook_endpoint_id: String,
+          event_type: OpenAI::Webhooks::WebhookTestParams::EventType::OrSymbol,
+          request_options: OpenAI::RequestOptions::OrHash
+        )
+          .returns(OpenAI::Webhooks::WebhookEndpointTestResult)
+      }
+      def test_(
+        # The ID of the webhook endpoint to test.
+        webhook_endpoint_id,
+        # The event type to send as a sample delivery.
+        event_type:,
+        request_options: {}
+      )
+      end
+
       # Validates that the given payload was sent by OpenAI and parses the payload.
       sig {
         params(

data/sig/openai/models/webhooks/deleted_webhook_endpoint.rbs

@@ -0,0 +1,28 @@
+module OpenAI
+  module Models
+    module Webhooks
+      type deleted_webhook_endpoint =
+        { id: String, deleted: bool, ?object: :"webhook_endpoint.deleted" }
+
+      class DeletedWebhookEndpoint < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor deleted: bool
+
+        attr_accessor object: :"webhook_endpoint.deleted"
+
+        def initialize: (
+          id: String,
+          deleted: bool,
+          ?object: :"webhook_endpoint.deleted"
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          deleted: bool,
+          ?object: :"webhook_endpoint.deleted"
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/webhooks/event_type_list_params.rbs

@@ -0,0 +1,16 @@
+module OpenAI
+  module Models
+    module Webhooks
+      type event_type_list_params = { ?request_options: OpenAI::request_opts }
+
+      class EventTypeListParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: OpenAI::request_opts) -> void
+
+        def to_hash: -> { ?request_options: OpenAI::RequestOptions }
+      end
+    end
+  end
+end

data/sig/openai/models/webhooks/webhook_create_params.rbs

@@ -0,0 +1,83 @@
+module OpenAI
+  module Models
+    module Webhooks
+      type webhook_create_params =
+        {
+          event_types: ::Array[OpenAI::Models::Webhooks::WebhookCreateParams::event_type],
+          name: String,
+          url: String,
+          ?request_options: OpenAI::request_opts
+        }
+
+      class WebhookCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor event_types: ::Array[OpenAI::Models::Webhooks::WebhookCreateParams::event_type]
+
+        attr_accessor name: String
+
+        attr_accessor url: String
+
+        def initialize: (
+          event_types: ::Array[OpenAI::Models::Webhooks::WebhookCreateParams::event_type],
+          name: String,
+          url: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          event_types: ::Array[OpenAI::Models::Webhooks::WebhookCreateParams::event_type],
+          name: String,
+          url: String,
+          ?request_options: OpenAI::RequestOptions
+        }
+
+        type event_type =
+          :"batch.completed"
+          | :"batch.failed"
+          | :"batch.expired"
+          | :"batch.cancelled"
+          | :"response.completed"
+          | :"response.failed"
+          | :"response.cancelled"
+          | :"response.incomplete"
+          | :"eval.run.succeeded"
+          | :"eval.run.failed"
+          | :"eval.run.canceled"
+          | :"fine_tuning.job.succeeded"
+          | :"fine_tuning.job.failed"
+          | :"fine_tuning.job.cancelled"
+          | :"realtime.call.incoming"
+          | :"video.completed"
+          | :"video.failed"
+          | :"safety.alert.created"
+
+        module EventType
+          extend OpenAI::Internal::Type::Enum
+
+          BATCH_COMPLETED: :"batch.completed"
+          BATCH_FAILED: :"batch.failed"
+          BATCH_EXPIRED: :"batch.expired"
+          BATCH_CANCELLED: :"batch.cancelled"
+          RESPONSE_COMPLETED: :"response.completed"
+          RESPONSE_FAILED: :"response.failed"
+          RESPONSE_CANCELLED: :"response.cancelled"
+          RESPONSE_INCOMPLETE: :"response.incomplete"
+          EVAL_RUN_SUCCEEDED: :"eval.run.succeeded"
+          EVAL_RUN_FAILED: :"eval.run.failed"
+          EVAL_RUN_CANCELED: :"eval.run.canceled"
+          FINE_TUNING_JOB_SUCCEEDED: :"fine_tuning.job.succeeded"
+          FINE_TUNING_JOB_FAILED: :"fine_tuning.job.failed"
+          FINE_TUNING_JOB_CANCELLED: :"fine_tuning.job.cancelled"
+          REALTIME_CALL_INCOMING: :"realtime.call.incoming"
+          VIDEO_COMPLETED: :"video.completed"
+          VIDEO_FAILED: :"video.failed"
+          SAFETY_ALERT_CREATED: :"safety.alert.created"
+
+          def self?.values: -> ::Array[OpenAI::Models::Webhooks::WebhookCreateParams::event_type]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/webhooks/webhook_delete_params.rbs

@@ -0,0 +1,25 @@
+module OpenAI
+  module Models
+    module Webhooks
+      type webhook_delete_params =
+        { webhook_endpoint_id: String, ?request_options: OpenAI::request_opts }
+
+      class WebhookDeleteParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor webhook_endpoint_id: String
+
+        def initialize: (
+          webhook_endpoint_id: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          webhook_endpoint_id: String,
+          ?request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/webhooks/webhook_endpoint.rbs

@@ -0,0 +1,59 @@
+module OpenAI
+  module Models
+    module Webhooks
+      type webhook_endpoint =
+        {
+          id: String,
+          created_at: Integer,
+          event_types: ::Array[String],
+          name: String,
+          ?object: :webhook_endpoint,
+          signing_secret_hint: String?,
+          url: String,
+          ?updated_at: Integer
+        }
+
+      class WebhookEndpoint < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Integer
+
+        attr_accessor event_types: ::Array[String]
+
+        attr_accessor name: String
+
+        attr_accessor object: :webhook_endpoint
+
+        attr_accessor signing_secret_hint: String?
+
+        attr_accessor url: String
+
+        attr_reader updated_at: Integer?
+
+        def updated_at=: (Integer) -> Integer
+
+        def initialize: (
+          id: String,
+          created_at: Integer,
+          event_types: ::Array[String],
+          name: String,
+          signing_secret_hint: String?,
+          url: String,
+          ?updated_at: Integer,
+          ?object: :webhook_endpoint
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Integer,
+          event_types: ::Array[String],
+          name: String,
+          ?object: :webhook_endpoint,
+          signing_secret_hint: String?,
+          url: String,
+          ?updated_at: Integer
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/webhooks/webhook_endpoint_list.rbs

@@ -0,0 +1,42 @@
+module OpenAI
+  module Models
+    module Webhooks
+      type webhook_endpoint_list =
+        {
+          data: ::Array[OpenAI::Webhooks::WebhookEndpoint],
+          first_id: String?,
+          has_more: bool,
+          last_id: String?,
+          ?object: :list
+        }
+
+      class WebhookEndpointList < OpenAI::Internal::Type::BaseModel
+        attr_accessor data: ::Array[OpenAI::Webhooks::WebhookEndpoint]
+
+        attr_accessor first_id: String?
+
+        attr_accessor has_more: bool
+
+        attr_accessor last_id: String?
+
+        attr_accessor object: :list
+
+        def initialize: (
+          data: ::Array[OpenAI::Webhooks::WebhookEndpoint],
+          first_id: String?,
+          has_more: bool,
+          last_id: String?,
+          ?object: :list
+        ) -> void
+
+        def to_hash: -> {
+          data: ::Array[OpenAI::Webhooks::WebhookEndpoint],
+          first_id: String?,
+          has_more: bool,
+          last_id: String?,
+          ?object: :list
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/webhooks/webhook_endpoint_test_result.rbs

@@ -0,0 +1,42 @@
+module OpenAI
+  module Models
+    module Webhooks
+      type webhook_endpoint_test_result =
+        {
+          event_type: String,
+          ?object: :"webhook_endpoint.test",
+          status_code: Integer,
+          success: bool,
+          webhook_endpoint_id: String
+        }
+
+      class WebhookEndpointTestResult < OpenAI::Internal::Type::BaseModel
+        attr_accessor event_type: String
+
+        attr_accessor object: :"webhook_endpoint.test"
+
+        attr_accessor status_code: Integer
+
+        attr_accessor success: bool
+
+        attr_accessor webhook_endpoint_id: String
+
+        def initialize: (
+          event_type: String,
+          status_code: Integer,
+          success: bool,
+          webhook_endpoint_id: String,
+          ?object: :"webhook_endpoint.test"
+        ) -> void
+
+        def to_hash: -> {
+          event_type: String,
+          ?object: :"webhook_endpoint.test",
+          status_code: Integer,
+          success: bool,
+          webhook_endpoint_id: String
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/webhooks/webhook_endpoint_with_secret.rbs

@@ -0,0 +1,64 @@
+module OpenAI
+  module Models
+    module Webhooks
+      type webhook_endpoint_with_secret =
+        {
+          id: String,
+          created_at: Integer,
+          event_types: ::Array[String],
+          name: String,
+          ?object: :webhook_endpoint,
+          signing_secret: String,
+          signing_secret_hint: String?,
+          url: String,
+          ?updated_at: Integer
+        }
+
+      class WebhookEndpointWithSecret < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Integer
+
+        attr_accessor event_types: ::Array[String]
+
+        attr_accessor name: String
+
+        attr_accessor object: :webhook_endpoint
+
+        attr_accessor signing_secret: String
+
+        attr_accessor signing_secret_hint: String?
+
+        attr_accessor url: String
+
+        attr_reader updated_at: Integer?
+
+        def updated_at=: (Integer) -> Integer
+
+        def initialize: (
+          id: String,
+          created_at: Integer,
+          event_types: ::Array[String],
+          name: String,
+          signing_secret: String,
+          signing_secret_hint: String?,
+          url: String,
+          ?updated_at: Integer,
+          ?object: :webhook_endpoint
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Integer,
+          event_types: ::Array[String],
+          name: String,
+          ?object: :webhook_endpoint,
+          signing_secret: String,
+          signing_secret_hint: String?,
+          url: String,
+          ?updated_at: Integer
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/webhooks/webhook_event_type_list.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Webhooks
+      type webhook_event_type_list = { data: ::Array[String], ?object: :list }
+
+      class WebhookEventTypeList < OpenAI::Internal::Type::BaseModel
+        attr_accessor data: ::Array[String]
+
+        attr_accessor object: :list
+
+        def initialize: (data: ::Array[String], ?object: :list) -> void
+
+        def to_hash: -> { data: ::Array[String], ?object: :list }
+      end
+    end
+  end
+end