openai 0.98.0 → 0.99.0

data/lib/openai/resources/images.rb

@@ -4,7 +4,11 @@ module OpenAI
   module Resources
     # Given a prompt and/or an input image, the model will generate a new image.
     class Images
-      # Creates a variation of a given image. This endpoint only supports `dall-e-2`.
+      # @deprecated
+      #
+      # This endpoint is retired and no longer available. Use the image edits endpoint
+      # with a GPT Image model and a prompt to create a variation of an image. The
+      # request and response schemas below describe the legacy contract.
       #
       # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -21,8 +25,8 @@ module OpenAI
       #   content type.
       #
       # @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
-      #   The model to use for image generation. Only `dall-e-2` is supported at this
-      #   time.
+      #   The legacy model used by the retired image variations endpoint. This endpoint no
+      #   longer accepts requests.
       #
       # @param n [Integer, nil]
       #   The number of images to generate. Must be between 1 and 10.
@@ -62,7 +66,7 @@ module OpenAI
       # See {OpenAI::Resources::Images#edit_stream_raw} for streaming counterpart.
       #
       # Creates an edited or extended image given one or more source images and a
-      # prompt. This endpoint supports GPT Image models and `dall-e-2`.
+      # prompt. This endpoint supports GPT Image models.
       #
       # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -80,16 +84,13 @@ module OpenAI
       #   be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
       #   images.
       #
-      #   For `dall-e-2`, you can only provide one image, and it should be a square `png`
-      #   file less than 4MB.
-      #
       #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
       #   content type.
       #
       # @param prompt [String]
-      #   A text description of the desired image(s). The maximum length is 1000
-      #   characters for `dall-e-2`, and 32000 characters for the GPT image models.
+      #   A text description of the desired image(s). The maximum length is 32000
+      #   characters for the GPT image models.
       #
       # @param background [Symbol, OpenAI::Models::ImageEditParams::Background, nil]
       #   Allows to set transparency for the background of the generated image(s). Must be
@@ -118,12 +119,11 @@ module OpenAI
       #   content type.
       #
       # @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
-      #   The model to use for image generation. One of `dall-e-2` or a GPT image model
-      #   (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
-      #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
-      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
-      #   `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to
-      #   `gpt-image-1.5`.
+      #   The GPT image model to use for image editing (`gpt-image-1`, `gpt-image-1-mini`,
+      #   `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
+      #   `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
+      #   `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
+      #   `chatgpt-image-latest`).
       #
       # @param n [Integer, nil]
       #   The number of images to generate. Must be between 1 and 10.
@@ -153,24 +153,21 @@ module OpenAI
       #   `xhigh` and `max`. Defaults to `auto`.
       #
       # @param response_format [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil]
-      #   The format in which the generated images are returned. Must be one of `url` or
-      #   `b64_json`. URLs are only valid for 60 minutes after the image has been
-      #   generated. This parameter is only supported for `dall-e-2` (default is `url` for
-      #   `dall-e-2`), as GPT image models always return base64-encoded images.
+      #   Legacy response format parameter for retired image models. Unsupported for GPT
+      #   image models, which always return base64-encoded images.
       #
       # @param size [String, Symbol, OpenAI::Models::ImageEditParams::Size, nil]
-      #   The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
-      #   `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
-      #   `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary
-      #   resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`.
-      #   Width and height must both be divisible by 16 and the requested aspect ratio
-      #   must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and
-      #   the maximum supported resolution is `3840x2160`. The requested size must also
-      #   satisfy the model's current pixel and edge limits. The standard sizes
-      #   `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-      #   `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-      #   one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-      #   `1024x1024`, `1792x1024`, or `1024x1792`.
+      #   The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
+      #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
+      #   `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as
+      #   `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be
+      #   divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1.
+      #   Resolutions above `2560x1440` are experimental, and the maximum supported
+      #   resolution is `3840x2160`. The requested size must also satisfy the model's
+      #   current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and
+      #   `1024x1536` are supported by the GPT image models; `auto` is supported for
+      #   models that allow automatic sizing.
       #
       # @param user [String]
       #   A unique identifier representing your end-user, which can help OpenAI to monitor
@@ -203,7 +200,7 @@ module OpenAI
       # See {OpenAI::Resources::Images#edit} for non-streaming counterpart.
       #
       # Creates an edited or extended image given one or more source images and a
-      # prompt. This endpoint supports GPT Image models and `dall-e-2`.
+      # prompt. This endpoint supports GPT Image models.
       #
       # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -221,16 +218,13 @@ module OpenAI
       #   be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
       #   images.
       #
-      #   For `dall-e-2`, you can only provide one image, and it should be a square `png`
-      #   file less than 4MB.
-      #
       #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
       #   content type.
       #
       # @param prompt [String]
-      #   A text description of the desired image(s). The maximum length is 1000
-      #   characters for `dall-e-2`, and 32000 characters for the GPT image models.
+      #   A text description of the desired image(s). The maximum length is 32000
+      #   characters for the GPT image models.
       #
       # @param background [Symbol, OpenAI::Models::ImageEditParams::Background, nil]
       #   Allows to set transparency for the background of the generated image(s). Must be
@@ -259,12 +253,11 @@ module OpenAI
       #   content type.
       #
       # @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
-      #   The model to use for image generation. One of `dall-e-2` or a GPT image model
-      #   (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
-      #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
-      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
-      #   `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to
-      #   `gpt-image-1.5`.
+      #   The GPT image model to use for image editing (`gpt-image-1`, `gpt-image-1-mini`,
+      #   `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
+      #   `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
+      #   `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
+      #   `chatgpt-image-latest`).
       #
       # @param n [Integer, nil]
       #   The number of images to generate. Must be between 1 and 10.
@@ -294,24 +287,21 @@ module OpenAI
       #   `xhigh` and `max`. Defaults to `auto`.
       #
       # @param response_format [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil]
-      #   The format in which the generated images are returned. Must be one of `url` or
-      #   `b64_json`. URLs are only valid for 60 minutes after the image has been
-      #   generated. This parameter is only supported for `dall-e-2` (default is `url` for
-      #   `dall-e-2`), as GPT image models always return base64-encoded images.
+      #   Legacy response format parameter for retired image models. Unsupported for GPT
+      #   image models, which always return base64-encoded images.
       #
       # @param size [String, Symbol, OpenAI::Models::ImageEditParams::Size, nil]
-      #   The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
-      #   `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
-      #   `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary
-      #   resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`.
-      #   Width and height must both be divisible by 16 and the requested aspect ratio
-      #   must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and
-      #   the maximum supported resolution is `3840x2160`. The requested size must also
-      #   satisfy the model's current pixel and edge limits. The standard sizes
-      #   `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-      #   `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-      #   one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-      #   `1024x1024`, `1792x1024`, or `1024x1792`.
+      #   The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
+      #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
+      #   `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as
+      #   `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be
+      #   divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1.
+      #   Resolutions above `2560x1440` are experimental, and the maximum supported
+      #   resolution is `3840x2160`. The requested size must also satisfy the model's
+      #   current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and
+      #   `1024x1536` are supported by the GPT image models; `auto` is supported for
+      #   models that allow automatic sizing.
       #
       # @param user [String]
       #   A unique identifier representing your end-user, which can help OpenAI to monitor
@@ -349,15 +339,14 @@ module OpenAI
 
       # See {OpenAI::Resources::Images#generate_stream_raw} for streaming counterpart.
       #
-      # Creates an image given a prompt.
+      # Creates an image given a prompt using a GPT Image model.
       # [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
       #
       # @overload generate(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
       #
       # @param prompt [String]
       #   A text description of the desired image(s). The maximum length is 32000
-      #   characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
-      #   characters for `dall-e-3`.
+      #   characters.
       #
       # @param background [Symbol, OpenAI::Models::ImageGenerateParams::Background, nil]
       #   Allows to set transparency for the background of the generated image(s). Must be
@@ -371,12 +360,11 @@ module OpenAI
       #   set the output format to `png` or `webp`.
       #
       # @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
-      #   The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT
-      #   image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
-      #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      #   The GPT image model to use for image generation. Specify a model explicitly.
+      #   Supported models include `gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+      #   `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
       #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
-      #   `gpt-image-2.5-flare-2026-09-08`). Defaults to `dall-e-2` unless a parameter
-      #   specific to the GPT image models is used.
+      #   `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
       #
       # @param moderation [Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil]
       #   Control the content-moderation level for images generated by the GPT image
@@ -384,8 +372,7 @@ module OpenAI
       #   value).
       #
       # @param n [Integer, nil]
-      #   The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
-      #   `n=1` is supported.
+      #   The number of images to generate. Must be between 1 and 10.
       #
       # @param output_compression [Integer, nil]
       #   The compression level (0-100%) for the generated images. This parameter is only
@@ -412,13 +399,9 @@ module OpenAI
       #   - `high`, `medium` and `low` are supported for the GPT image models.
       #   - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
       #     `2026-09-08` snapshots, also support `xhigh` and `max`.
-      #   - `hd` and `standard` are supported for `dall-e-3`.
-      #   - `standard` is the only option for `dall-e-2`.
       #
       # @param response_format [Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil]
-      #   The format in which generated images with `dall-e-2` and `dall-e-3` are
-      #   returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes
-      #   after the image has been generated. This parameter isn't supported for the GPT
+      #   Legacy response format parameter for retired image models. Unsupported for GPT
       #   image models, which always return base64-encoded images.
       #
       # @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
@@ -431,15 +414,11 @@ module OpenAI
       #   the maximum supported resolution is `3840x2160`. The requested size must also
       #   satisfy the model's current pixel and edge limits. The standard sizes
       #   `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-      #   `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-      #   one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-      #   `1024x1024`, `1792x1024`, or `1024x1792`.
+      #   `auto` is supported for models that allow automatic sizing.
       #
       # @param style [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil]
-      #   The style of the generated images. This parameter is only supported for
-      #   `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
-      #   towards generating hyper-real and dramatic images. Natural causes the model to
-      #   produce more natural, less hyper-real looking images.
+      #   Legacy style parameter for retired image models. Unsupported for GPT image
+      #   models; describe the desired style in the prompt instead.
       #
       # @param user [String]
       #   A unique identifier representing your end-user, which can help OpenAI to monitor
@@ -470,15 +449,14 @@ module OpenAI
 
       # See {OpenAI::Resources::Images#generate} for non-streaming counterpart.
       #
-      # Creates an image given a prompt.
+      # Creates an image given a prompt using a GPT Image model.
       # [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
       #
       # @overload generate_stream_raw(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
       #
       # @param prompt [String]
       #   A text description of the desired image(s). The maximum length is 32000
-      #   characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
-      #   characters for `dall-e-3`.
+      #   characters.
       #
       # @param background [Symbol, OpenAI::Models::ImageGenerateParams::Background, nil]
       #   Allows to set transparency for the background of the generated image(s). Must be
@@ -492,12 +470,11 @@ module OpenAI
       #   set the output format to `png` or `webp`.
       #
       # @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
-      #   The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT
-      #   image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
-      #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      #   The GPT image model to use for image generation. Specify a model explicitly.
+      #   Supported models include `gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+      #   `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
       #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
-      #   `gpt-image-2.5-flare-2026-09-08`). Defaults to `dall-e-2` unless a parameter
-      #   specific to the GPT image models is used.
+      #   `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
       #
       # @param moderation [Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil]
       #   Control the content-moderation level for images generated by the GPT image
@@ -505,8 +482,7 @@ module OpenAI
       #   value).
       #
       # @param n [Integer, nil]
-      #   The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
-      #   `n=1` is supported.
+      #   The number of images to generate. Must be between 1 and 10.
       #
       # @param output_compression [Integer, nil]
       #   The compression level (0-100%) for the generated images. This parameter is only
@@ -533,13 +509,9 @@ module OpenAI
       #   - `high`, `medium` and `low` are supported for the GPT image models.
       #   - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
       #     `2026-09-08` snapshots, also support `xhigh` and `max`.
-      #   - `hd` and `standard` are supported for `dall-e-3`.
-      #   - `standard` is the only option for `dall-e-2`.
       #
       # @param response_format [Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil]
-      #   The format in which generated images with `dall-e-2` and `dall-e-3` are
-      #   returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes
-      #   after the image has been generated. This parameter isn't supported for the GPT
+      #   Legacy response format parameter for retired image models. Unsupported for GPT
       #   image models, which always return base64-encoded images.
       #
       # @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
@@ -552,15 +524,11 @@ module OpenAI
       #   the maximum supported resolution is `3840x2160`. The requested size must also
       #   satisfy the model's current pixel and edge limits. The standard sizes
       #   `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-      #   `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-      #   one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-      #   `1024x1024`, `1792x1024`, or `1024x1792`.
+      #   `auto` is supported for models that allow automatic sizing.
       #
       # @param style [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil]
-      #   The style of the generated images. This parameter is only supported for
-      #   `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
-      #   towards generating hyper-real and dramatic images. Natural causes the model to
-      #   produce more natural, less hyper-real looking images.
+      #   Legacy style parameter for retired image models. Unsupported for GPT image
+      #   models; describe the desired style in the prompt instead.
       #
       # @param user [String]
       #   A unique identifier representing your end-user, which can help OpenAI to monitor

data/lib/openai/resources/webhooks.rb

@@ -203,7 +203,7 @@ module OpenAI
       # @param headers [Hash] The webhook headers
       # @param webhook_secret [String, nil] The webhook secret (optional, will use client webhook secret or ENV["OPENAI_WEBHOOK_SECRET"] if not provided)
       #
-      # @return [OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent]
+      # @return [OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent, OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent, OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent, OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent]
       #
       # @raise [ArgumentError] if signature verification fails
       def unwrap(

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.98.0"
+  VERSION = "0.99.0"
 end

data/lib/openai.rb

@@ -454,6 +454,8 @@ require_relative "openai/models/audio/translation"
 require_relative "openai/models/audio/translation_create_params"
 require_relative "openai/models/audio/translation_create_response"
 require_relative "openai/models/audio/translation_verbose"
+require_relative "openai/models/audio/voice"
+require_relative "openai/models/audio/voice_create_params"
 require_relative "openai/models/audio_model"
 require_relative "openai/models/audio_response_format"
 require_relative "openai/models/auto_file_chunking_strategy_param"
@@ -1435,6 +1437,11 @@ require_relative "openai/models/video_remix_params"
 require_relative "openai/models/video_retrieve_params"
 require_relative "openai/models/video_seconds"
 require_relative "openai/models/video_size"
+require_relative "openai/models/webhooks/agent_session_action_required_webhook_event"
+require_relative "openai/models/webhooks/agent_session_created_webhook_event"
+require_relative "openai/models/webhooks/agent_session_failed_webhook_event"
+require_relative "openai/models/webhooks/agent_session_idle_webhook_event"
+require_relative "openai/models/webhooks/agent_session_in_progress_webhook_event"
 require_relative "openai/models/webhooks/batch_cancelled_webhook_event"
 require_relative "openai/models/webhooks/batch_completed_webhook_event"
 require_relative "openai/models/webhooks/batch_expired_webhook_event"
@@ -1510,6 +1517,7 @@ require_relative "openai/resources/audio"
 require_relative "openai/resources/audio/speech"
 require_relative "openai/resources/audio/transcriptions"
 require_relative "openai/resources/audio/translations"
+require_relative "openai/resources/audio/voices"
 require_relative "openai/resources/batches"
 require_relative "openai/resources/beta"
 require_relative "openai/resources/beta/agents"

data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi

@@ -206,7 +206,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -322,6 +331,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -382,7 +393,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -448,6 +464,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi

@@ -208,7 +208,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -324,6 +333,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -384,7 +395,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -450,6 +466,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi

@@ -210,7 +210,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -326,6 +335,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -386,7 +397,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -452,6 +468,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

data/rbi/openai/models/admin/organization/usage_completions_response.rbi

@@ -206,7 +206,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -322,6 +331,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -382,7 +393,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -448,6 +464,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

data/rbi/openai/models/admin/organization/usage_costs_response.rbi

@@ -202,7 +202,16 @@ module OpenAI
                 sig { params(input_audio_tokens: Integer).void }
                 attr_writer :input_audio_tokens
 
-                # The aggregated number of input tokens written to the cache.
+                # The aggregated number of input tokens written to the cache with a 12-hour
+                # retention period.
+                sig { returns(T.nilable(Integer)) }
+                attr_reader :input_cache_write_12h_tokens
+
+                sig { params(input_cache_write_12h_tokens: Integer).void }
+                attr_writer :input_cache_write_12h_tokens
+
+                # The aggregated number of input tokens written to the cache with a 30-minute
+                # retention period.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -318,6 +327,8 @@ module OpenAI
 
                     input_audio_tokens: Integer,
 
+                    input_cache_write_12h_tokens: Integer,
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -378,7 +389,12 @@ module OpenAI
                   # The aggregated number of uncached audio input tokens used.
                   input_audio_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache.
+                  # The aggregated number of input tokens written to the cache with a 12-hour
+                  # retention period.
+                  input_cache_write_12h_tokens: nil,
+
+                  # The aggregated number of input tokens written to the cache with a 30-minute
+                  # retention period.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -444,6 +460,7 @@ module OpenAI
                       api_key_id: T.nilable(String),
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
+                      input_cache_write_12h_tokens: Integer,
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,