openai 0.91.0 → 0.93.0

data/rbi/openai/resources/responses.rbi

@@ -3,11 +3,14 @@
 module OpenAI
   module Resources
 
+    # Create and manage model responses.
     class Responses
 
+      # Create and manage model responses.
       sig { returns(OpenAI::Resources::Responses::InputItems) }
       attr_reader :input_items
 
+      # Create and manage model responses.
       sig { returns(OpenAI::Resources::Responses::InputTokens) }
       attr_reader :input_tokens
 

data/rbi/openai/resources/safety/cases.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Safety
+
+      class Cases
+
+        # Get a safety case by ID.
+        sig { params(id: String, request_options: OpenAI::RequestOptions::OrHash).returns(OpenAI::Safety::SafetyCase) }
+        def retrieve(
+          # Safety case ID
+          id,
+          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/safety.rbi

@@ -5,6 +5,9 @@ module OpenAI
 
     class Safety
 
+      sig { returns(OpenAI::Resources::Safety::Cases) }
+      attr_reader :cases
+
       sig { returns(OpenAI::Resources::Safety::Alerts) }
       attr_reader :alerts
 

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(
@@ -32,7 +158,9 @@ module OpenAI
               OpenAI::Webhooks::ResponseFailedWebhookEvent,
               OpenAI::Webhooks::ResponseIncompleteWebhookEvent,
               OpenAI::Webhooks::SafetyAlertCreatedWebhookEvent,
-              OpenAI::Webhooks::SafetyOrgAlertCreatedWebhookEvent
+              OpenAI::Webhooks::SafetyDeactivationIssuedWebhookEvent,
+              OpenAI::Webhooks::SafetyOrgAlertCreatedWebhookEvent,
+              OpenAI::Webhooks::SafetyWarningIssuedWebhookEvent
             )
           )
       }

data/sig/openai/models/admin/organization/admin_api_key.rbs

@@ -15,22 +15,43 @@ module OpenAI
           }
 
         class AdminAPIKey < OpenAI::Internal::Type::BaseModel
+          # The identifier, which can be referenced in API endpoints
           attr_accessor id: String
 
+          # The Unix timestamp (in seconds) of when the API key was created
           attr_accessor created_at: Integer
 
+          # The Unix timestamp (in seconds) of when the API key expires
           attr_accessor expires_at: Integer?
 
+          # The object type, which is always `organization.admin_api_key`
           attr_accessor object: :"organization.admin_api_key"
 
           attr_accessor owner: OpenAI::Admin::Organization::AdminAPIKey::Owner
 
+          # The redacted value of the API key
           attr_accessor redacted_value: String
 
+          # The Unix timestamp (in seconds) of when the API key was last used
           attr_accessor last_used_at: Integer?
 
+          # The name of the API key
           attr_accessor name: String?
 
+          # @param id
+          #   The identifier, which can be referenced in API endpoints
+          # @param created_at
+          #   The Unix timestamp (in seconds) of when the API key was created
+          # @param expires_at
+          #   The Unix timestamp (in seconds) of when the API key expires
+          # @param redacted_value
+          #   The redacted value of the API key
+          # @param last_used_at
+          #   The Unix timestamp (in seconds) of when the API key was last used
+          # @param name
+          #   The name of the API key
+          # @param object
+          #   The object type, which is always `organization.admin_api_key`
           def initialize: (
             id: String,
             created_at: Integer,
@@ -64,30 +85,54 @@ module OpenAI
             }
 
           class Owner < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints
             attr_reader id: String?
 
+            # The identifier, which can be referenced in API endpoints
             def id=: (String) -> String
 
+            # The Unix timestamp (in seconds) of when the user was created
             attr_reader created_at: Integer?
 
+            # The Unix timestamp (in seconds) of when the user was created
             def created_at=: (Integer) -> Integer
 
+            # The name of the user
             attr_reader name: String?
 
+            # The name of the user
             def name=: (String) -> String
 
+            # The object type, which is always organization.user
             attr_reader object: String?
 
+            # The object type, which is always organization.user
             def object=: (String) -> String
 
+            # Always `owner`
             attr_reader role: String?
 
+            # Always `owner`
             def role=: (String) -> String
 
+            # Always `user`
             attr_reader type: String?
 
+            # Always `user`
             def type=: (String) -> String
 
+            # @param id
+            #   The identifier, which can be referenced in API endpoints
+            # @param created_at
+            #   The Unix timestamp (in seconds) of when the user was created
+            # @param name
+            #   The name of the user
+            # @param object
+            #   The object type, which is always organization.user
+            # @param role
+            #   Always `owner`
+            # @param type
+            #   Always `user`
             def initialize: (
               ?id: String,
               ?created_at: Integer,

data/sig/openai/models/admin/organization/admin_api_key_create_params.rbs

@@ -15,10 +15,17 @@ module OpenAI
 
           attr_accessor name: String
 
+          # The number of seconds until the API key expires. Omit this field for a key that
+          # does not expire.
           attr_reader expires_in_seconds: Integer?
 
+          # The number of seconds until the API key expires. Omit this field for a key that
+          # does not expire.
           def expires_in_seconds=: (Integer) -> Integer
 
+          # @param expires_in_seconds
+          #   The number of seconds until the API key expires. Omit this field for a key that
+          #   does not expire.
           def initialize: (
             name: String,
             ?expires_in_seconds: Integer,

data/sig/openai/models/admin/organization/admin_api_key_create_response.rbs

@@ -16,10 +16,28 @@ module OpenAI
           }
 
         class AdminAPIKeyCreateResponse < OpenAI::Models::Admin::Organization::AdminAPIKey
+          # The value of the API key. Only shown on create.
           def value: -> String
 
+          # The value of the API key. Only shown on create.
           def value=: (String _) -> String
 
+          # @param id
+          #   The identifier, which can be referenced in API endpoints
+          # @param created_at
+          #   The Unix timestamp (in seconds) of when the API key was created
+          # @param expires_at
+          #   The Unix timestamp (in seconds) of when the API key expires
+          # @param redacted_value
+          #   The redacted value of the API key
+          # @param value
+          #   The value of the API key. Only shown on create.
+          # @param last_used_at
+          #   The Unix timestamp (in seconds) of when the API key was last used
+          # @param name
+          #   The name of the API key
+          # @param object
+          #   The object type, which is always `organization.admin_api_key`
           def initialize: (
             id: String,
             created_at: Integer,

data/sig/openai/models/admin/organization/admin_api_key_delete_params.rbs

@@ -9,8 +9,11 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # The ID of the API key to be deleted.
           attr_accessor key_id: String
 
+          # @param key_id
+          #   The ID of the API key to be deleted.
           def initialize: (
             key_id: String,
             ?request_options: OpenAI::request_opts

data/sig/openai/models/admin/organization/admin_api_key_list_params.rbs

@@ -14,18 +14,29 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # Return keys with IDs that come after this ID in the pagination order.
           attr_accessor after: String?
 
+          # Maximum number of keys to return.
           attr_reader limit: Integer?
 
+          # Maximum number of keys to return.
           def limit=: (Integer) -> Integer
 
+          # Order results by creation time, ascending or descending.
           attr_reader order: OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order?
 
+          # Order results by creation time, ascending or descending.
           def order=: (
             OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order
           ) -> OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::order
 
+          # @param after
+          #   Return keys with IDs that come after this ID in the pagination order.
+          # @param limit
+          #   Maximum number of keys to return.
+          # @param order
+          #   Order results by creation time, ascending or descending.
           def initialize: (
             ?after: String?,
             ?limit: Integer,

data/sig/openai/models/admin/organization/admin_api_key_retrieve_params.rbs

@@ -9,8 +9,11 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # The ID of the API key.
           attr_accessor key_id: String
 
+          # @param key_id
+          #   The ID of the API key.
           def initialize: (
             key_id: String,
             ?request_options: OpenAI::request_opts

data/sig/openai/models/admin/organization/audit_log_list_params.rbs

@@ -21,50 +21,135 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # Return only events performed by users with these emails.
           attr_reader actor_emails: ::Array[String]?
 
+          # Return only events performed by users with these emails.
           def actor_emails=: (::Array[String]) -> ::Array[String]
 
+          # Return only events performed by these actors. Can be a user ID, a service
+          # account ID, or an api key tracking ID.
           attr_reader actor_ids: ::Array[String]?
 
+          # Return only events performed by these actors. Can be a user ID, a service
+          # account ID, or an api key tracking ID.
           def actor_ids=: (::Array[String]) -> ::Array[String]
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           attr_reader after: String?
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           def after=: (String) -> String
 
+          # A cursor for use in pagination. `before` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # starting with obj_foo, your subsequent call can include before=obj_foo in order
+          # to fetch the previous page of the list.
           attr_reader before: String?
 
+          # A cursor for use in pagination. `before` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # starting with obj_foo, your subsequent call can include before=obj_foo in order
+          # to fetch the previous page of the list.
           def before=: (String) -> String
 
+          # Return only events whose `effective_at` (Unix seconds) is in this range.
           attr_reader effective_at: OpenAI::Admin::Organization::AuditLogListParams::EffectiveAt?
 
+          # Return only events whose `effective_at` (Unix seconds) is in this range.
           def effective_at=: (
             OpenAI::Admin::Organization::AuditLogListParams::EffectiveAt
           ) -> OpenAI::Admin::Organization::AuditLogListParams::EffectiveAt
 
+          # Return only events with a `type` in one of these values. For example,
+          # `project.created`. For all options, see the documentation for the
+          # [audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs).
           attr_reader event_types: ::Array[OpenAI::Models::Admin::Organization::AuditLogListParams::event_type]?
 
+          # Return only events with a `type` in one of these values. For example,
+          # `project.created`. For all options, see the documentation for the
+          # [audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs).
           def event_types=: (
             ::Array[OpenAI::Models::Admin::Organization::AuditLogListParams::event_type]
           ) -> ::Array[OpenAI::Models::Admin::Organization::AuditLogListParams::event_type]
 
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
           attr_reader limit: Integer?
 
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
           def limit=: (Integer) -> Integer
 
+          # Return only events for these projects.
           attr_reader project_ids: ::Array[String]?
 
+          # Return only events for these projects.
           def project_ids=: (::Array[String]) -> ::Array[String]
 
+          # Return only events performed on these targets. For example, a project ID
+          # updated. For ChatGPT connector role events, use the workspace connector resource
+          # ID shown in `details.id`, such as `<workspace_id>__<connector_id>`.
           attr_reader resource_ids: ::Array[String]?
 
+          # Return only events performed on these targets. For example, a project ID
+          # updated. For ChatGPT connector role events, use the workspace connector resource
+          # ID shown in `details.id`, such as `<workspace_id>__<connector_id>`.
           def resource_ids=: (::Array[String]) -> ::Array[String]
 
+          # Return only tenant-scoped events associated with this organization. Required for
+          # tenant-scoped events such as `role.bound_to_resource` and
+          # `role.unbound_from_resource`. When `true`, all supplied event types must be
+          # tenant-scoped.
           attr_reader tenant_only: bool?
 
+          # Return only tenant-scoped events associated with this organization. Required for
+          # tenant-scoped events such as `role.bound_to_resource` and
+          # `role.unbound_from_resource`. When `true`, all supplied event types must be
+          # tenant-scoped.
           def tenant_only=: (bool) -> bool
 
+          # @param actor_emails
+          #   Return only events performed by users with these emails.
+          # @param actor_ids
+          #   Return only events performed by these actors. Can be a user ID, a service
+          #   account ID, or an api key tracking ID.
+          # @param after
+          #   A cursor for use in pagination. `after` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          #   fetch the next page of the list.
+          # @param before
+          #   A cursor for use in pagination. `before` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   starting with obj_foo, your subsequent call can include before=obj_foo in order
+          #   to fetch the previous page of the list.
+          # @param effective_at
+          #   Return only events whose `effective_at` (Unix seconds) is in this range.
+          # @param event_types
+          #   Return only events with a `type` in one of these values. For example,
+          #   `project.created`. For all options, see the documentation for the
+          #   [audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs).
+          # @param limit
+          #   A limit on the number of objects to be returned. Limit can range between 1 and
+          #   100, and the default is 20.
+          # @param project_ids
+          #   Return only events for these projects.
+          # @param resource_ids
+          #   Return only events performed on these targets. For example, a project ID
+          #   updated. For ChatGPT connector role events, use the workspace connector resource
+          #   ID shown in `details.id`, such as `<workspace_id>__<connector_id>`.
+          # @param tenant_only
+          #   Return only tenant-scoped events associated with this organization. Required for
+          #   tenant-scoped events such as `role.bound_to_resource` and
+          #   `role.unbound_from_resource`. When `true`, all supplied event types must be
+          #   tenant-scoped.
           def initialize: (
             ?actor_emails: ::Array[String],
             ?actor_ids: ::Array[String],
@@ -97,22 +182,47 @@ module OpenAI
             { ?gt: Integer, ?gte: Integer, ?lt: Integer, ?lte: Integer }
 
           class EffectiveAt < OpenAI::Internal::Type::BaseModel
+            # Return only events whose `effective_at` (Unix seconds) is greater than this
+            # value.
             attr_reader gt: Integer?
 
+            # Return only events whose `effective_at` (Unix seconds) is greater than this
+            # value.
             def gt=: (Integer) -> Integer
 
+            # Return only events whose `effective_at` (Unix seconds) is greater than or equal
+            # to this value.
             attr_reader gte: Integer?
 
+            # Return only events whose `effective_at` (Unix seconds) is greater than or equal
+            # to this value.
             def gte=: (Integer) -> Integer
 
+            # Return only events whose `effective_at` (Unix seconds) is less than this value.
             attr_reader lt: Integer?
 
+            # Return only events whose `effective_at` (Unix seconds) is less than this value.
             def lt=: (Integer) -> Integer
 
+            # Return only events whose `effective_at` (Unix seconds) is less than or equal to
+            # this value.
             attr_reader lte: Integer?
 
+            # Return only events whose `effective_at` (Unix seconds) is less than or equal to
+            # this value.
             def lte=: (Integer) -> Integer
 
+            # @param gt
+            #   Return only events whose `effective_at` (Unix seconds) is greater than this
+            #   value.
+            # @param gte
+            #   Return only events whose `effective_at` (Unix seconds) is greater than or equal
+            #   to this value.
+            # @param lt
+            #   Return only events whose `effective_at` (Unix seconds) is less than this value.
+            # @param lte
+            #   Return only events whose `effective_at` (Unix seconds) is less than or equal to
+            #   this value.
             def initialize: (
               ?gt: Integer,
               ?gte: Integer,
@@ -141,6 +251,8 @@ module OpenAI
             | :"checkpoint.permission.deleted"
             | :"external_key.registered"
             | :"external_key.removed"
+            | :"external_storage.registered"
+            | :"external_storage.removed"
             | :"group.created"
             | :"group.updated"
             | :"group.deleted"
@@ -292,6 +404,8 @@ module OpenAI
             CHECKPOINT_PERMISSION_DELETED: :"checkpoint.permission.deleted"
             EXTERNAL_KEY_REGISTERED: :"external_key.registered"
             EXTERNAL_KEY_REMOVED: :"external_key.removed"
+            EXTERNAL_STORAGE_REGISTERED: :"external_storage.registered"
+            EXTERNAL_STORAGE_REMOVED: :"external_storage.removed"
             GROUP_CREATED: :"group.created"
             GROUP_UPDATED: :"group.updated"
             GROUP_DELETED: :"group.deleted"