openai 0.91.0 → 0.92.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a61cd08e625c8aba5c20a9b541efa3deed121cf8ffdd5fb297e4326de359fc7
-  data.tar.gz: 64bf26a74023158218b6b64e113231a3dffece2b104ea7c8802ca774bb092173
+  metadata.gz: cffa890096f3dffc816f33f1dc127e4f6e6e59bbb617208c1ec9aabc0f266870
+  data.tar.gz: de0f3f0244061e0ddc31afb1130e1671e6d6cf44a44cd8720bf1b906c7ba86ce
 SHA512:
-  metadata.gz: 37ae5e3821eaa44ddccf1727c913aa6551dd1d3a432e7b3be44ba98b8fa2497e5c87b9a0ac58ef44c3e1a3f338e3dff6d5e1f81ee86ef1a0f035b8c0152c5806
-  data.tar.gz: 5162f83225a3a33fe9e7937cf43294f4bfc141963e52ba2d886dd6a642dc16d76dbd43235faf5157bfaa9bb3aed556836b44215649d05178127142bf9a2f80ed
+  metadata.gz: c8ed8ae0a55179307ddfd9b92adc9301ba2f3529e4fc8cbb08eed06ce0b31f07695097d93b1be0bf138453bdeeb1167f9d15c6b40e711c49863bde42da6e1dad
+  data.tar.gz: c703f534854428406bec718e1ec3320237ad421bf91658b9b06e4a664966dc6fa8c4887ee85326abd892c7f9ee2d1051e71a4d65528daf9c622732c340d355c6

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.92.0](https://github.com/openai/openai-ruby/compare/v0.91.0...v0.92.0) (2026-09-18)
+
+
+### Features
+
+* **api:** add webhook endpoint management ([#715](https://github.com/openai/openai-ruby/issues/715)) ([200081b](https://github.com/openai/openai-ruby/commit/200081baaa078144426ba3678661fd63a9eaafb0))
+
+
+### Chores
+
+* **api:** deprecate MCP connector_id ([#717](https://github.com/openai/openai-ruby/issues/717)) ([d64821b](https://github.com/openai/openai-ruby/commit/d64821b69a34e8382a6c9fd67764c2081f403d38))
+
 ## [0.91.0](https://github.com/openai/openai-ruby/compare/v0.90.0...v0.91.0) (2026-09-18)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.91.0"
+gem "openai", "~> 0.92.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/openai/models/beta/beta_tool.rb

@@ -96,11 +96,17 @@ module OpenAI
           optional :authorization, String
 
           # @!attribute connector_id
+          #   @deprecated
+          #
           #   Identifier for service connectors, like those available in ChatGPT. One of
           #   `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
           #   service connectors
           #   [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
+          #   This field is deprecated for models released after September 1, 2026. Use
+          #   `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+          #   through a Secure MCP Tunnel.
+          #
           #   Currently supported `connector_id` values are:
           #
           #   - Dropbox: `connector_dropbox`
@@ -179,6 +185,10 @@ module OpenAI
           #     service connectors
           #     [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
+          #     This field is deprecated for models released after September 1, 2026. Use
+          #     `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+          #     through a Secure MCP Tunnel.
+          #
           #     Currently supported `connector_id` values are:
           #
           #     - Dropbox: `connector_dropbox`
@@ -271,11 +281,17 @@ module OpenAI
             StringArray = OpenAI::Internal::Type::ArrayOf[String]
           end
 
+          # @deprecated
+          #
           # Identifier for service connectors, like those available in ChatGPT. One of
           # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
           # service connectors
           # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
+          # This field is deprecated for models released after September 1, 2026. Use
+          # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+          # through a Secure MCP Tunnel.
+          #
           # Currently supported `connector_id` values are:
           #
           # - Dropbox: `connector_dropbox`

data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb

@@ -47,11 +47,17 @@ module OpenAI
         optional :authorization, String
 
         # @!attribute connector_id
+        #   @deprecated
+        #
         #   Identifier for service connectors, like those available in ChatGPT. One of
         #   `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
         #   service connectors
         #   [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
         #
+        #   This field is deprecated for models released after September 1, 2026. Use
+        #   `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+        #   through a Secure MCP Tunnel.
+        #
         #   Currently supported `connector_id` values are:
         #
         #   - Dropbox: `connector_dropbox`
@@ -134,6 +140,10 @@ module OpenAI
         #     service connectors
         #     [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
         #
+        #     This field is deprecated for models released after September 1, 2026. Use
+        #     `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+        #     through a Secure MCP Tunnel.
+        #
         #     Currently supported `connector_id` values are:
         #
         #     - Dropbox: `connector_dropbox`
@@ -226,11 +236,17 @@ module OpenAI
           StringArray = OpenAI::Internal::Type::ArrayOf[String]
         end
 
+        # @deprecated
+        #
         # Identifier for service connectors, like those available in ChatGPT. One of
         # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
         # service connectors
         # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
         #
+        # This field is deprecated for models released after September 1, 2026. Use
+        # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+        # through a Secure MCP Tunnel.
+        #
         # Currently supported `connector_id` values are:
         #
         # - Dropbox: `connector_dropbox`

data/lib/openai/models/realtime/realtime_session_create_response.rb

@@ -960,11 +960,17 @@ module OpenAI
             optional :authorization, String
 
             # @!attribute connector_id
+            #   @deprecated
+            #
             #   Identifier for service connectors, like those available in ChatGPT. One of
             #   `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
             #   service connectors
             #   [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
             #
+            #   This field is deprecated for models released after September 1, 2026. Use
+            #   `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+            #   through a Secure MCP Tunnel.
+            #
             #   Currently supported `connector_id` values are:
             #
             #   - Dropbox: `connector_dropbox`
@@ -1052,6 +1058,10 @@ module OpenAI
             #     service connectors
             #     [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
             #
+            #     This field is deprecated for models released after September 1, 2026. Use
+            #     `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+            #     through a Secure MCP Tunnel.
+            #
             #     Currently supported `connector_id` values are:
             #
             #     - Dropbox: `connector_dropbox`
@@ -1150,11 +1160,17 @@ module OpenAI
               StringArray = OpenAI::Internal::Type::ArrayOf[String]
             end
 
+            # @deprecated
+            #
             # Identifier for service connectors, like those available in ChatGPT. One of
             # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
             # service connectors
             # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
             #
+            # This field is deprecated for models released after September 1, 2026. Use
+            # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+            # through a Secure MCP Tunnel.
+            #
             # Currently supported `connector_id` values are:
             #
             # - Dropbox: `connector_dropbox`

data/lib/openai/models/realtime/realtime_tools_config_union.rb

@@ -61,11 +61,17 @@ module OpenAI
           optional :authorization, String
 
           # @!attribute connector_id
+          #   @deprecated
+          #
           #   Identifier for service connectors, like those available in ChatGPT. One of
           #   `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
           #   service connectors
           #   [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
+          #   This field is deprecated for models released after September 1, 2026. Use
+          #   `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+          #   through a Secure MCP Tunnel.
+          #
           #   Currently supported `connector_id` values are:
           #
           #   - Dropbox: `connector_dropbox`
@@ -148,6 +154,10 @@ module OpenAI
           #     service connectors
           #     [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
+          #     This field is deprecated for models released after September 1, 2026. Use
+          #     `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+          #     through a Secure MCP Tunnel.
+          #
           #     Currently supported `connector_id` values are:
           #
           #     - Dropbox: `connector_dropbox`
@@ -240,11 +250,17 @@ module OpenAI
             StringArray = OpenAI::Internal::Type::ArrayOf[String]
           end
 
+          # @deprecated
+          #
           # Identifier for service connectors, like those available in ChatGPT. One of
           # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
           # service connectors
           # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
+          # This field is deprecated for models released after September 1, 2026. Use
+          # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+          # through a Secure MCP Tunnel.
+          #
           # Currently supported `connector_id` values are:
           #
           # - Dropbox: `connector_dropbox`

data/lib/openai/models/responses/tool.rb

@@ -98,11 +98,17 @@ module OpenAI
           optional :authorization, String
 
           # @!attribute connector_id
+          #   @deprecated
+          #
           #   Identifier for service connectors, like those available in ChatGPT. One of
           #   `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
           #   service connectors
           #   [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
+          #   This field is deprecated for models released after September 1, 2026. Use
+          #   `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+          #   through a Secure MCP Tunnel.
+          #
           #   Currently supported `connector_id` values are:
           #
           #   - Dropbox: `connector_dropbox`
@@ -181,6 +187,10 @@ module OpenAI
           #     service connectors
           #     [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
+          #     This field is deprecated for models released after September 1, 2026. Use
+          #     `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+          #     through a Secure MCP Tunnel.
+          #
           #     Currently supported `connector_id` values are:
           #
           #     - Dropbox: `connector_dropbox`
@@ -273,11 +283,17 @@ module OpenAI
             StringArray = OpenAI::Internal::Type::ArrayOf[String]
           end
 
+          # @deprecated
+          #
           # Identifier for service connectors, like those available in ChatGPT. One of
           # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
           # service connectors
           # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
+          # This field is deprecated for models released after September 1, 2026. Use
+          # `server_url` to connect to a remote MCP server, or `tunnel_id` to connect
+          # through a Secure MCP Tunnel.
+          #
           # Currently supported `connector_id` values are:
           #
           # - Dropbox: `connector_dropbox`

data/lib/openai/models/webhooks/deleted_webhook_endpoint.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      # @see OpenAI::Resources::Webhooks#delete
+      class DeletedWebhookEndpoint < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the deleted webhook endpoint.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute deleted
+        #   Whether the endpoint was deleted.
+        #
+        #   @return [Boolean]
+        required :deleted, OpenAI::Internal::Type::Boolean
+
+        # @!attribute object
+        #   The object type, which is always webhook_endpoint.deleted.
+        #
+        #   @return [Symbol, :"webhook_endpoint.deleted"]
+        required :object, const: :"webhook_endpoint.deleted"
+
+        # @!method initialize(id:, deleted:, object: :"webhook_endpoint.deleted")
+        #   @param id [String]
+        #     The ID of the deleted webhook endpoint.
+        #
+        #   @param deleted [Boolean]
+        #     Whether the endpoint was deleted.
+        #
+        #   @param object [Symbol, :"webhook_endpoint.deleted"]
+        #     The object type, which is always webhook_endpoint.deleted.
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/event_type_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      # @see OpenAI::Resources::Webhooks::EventTypes#list
+      class EventTypeListParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/webhook_create_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      # @see OpenAI::Resources::Webhooks#create
+      class WebhookCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute event_types
+        #   The event types that trigger deliveries to this endpoint.
+        #
+        #   @return [Array<Symbol, OpenAI::Models::Webhooks::WebhookCreateParams::EventType>]
+        required(
+          :event_types,
+          -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Webhooks::WebhookCreateParams::EventType] }
+        )
+
+        # @!attribute name
+        #   A human-readable name for the webhook endpoint.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute url
+        #   The HTTPS URL that receives webhook deliveries.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(event_types:, name:, url:, request_options: {})
+        #   @param event_types [Array<Symbol, OpenAI::Models::Webhooks::WebhookCreateParams::EventType>]
+        #     The event types that trigger deliveries to this endpoint.
+        #
+        #   @param name [String]
+        #     A human-readable name for the webhook endpoint.
+        #
+        #   @param url [String]
+        #     The HTTPS URL that receives webhook deliveries.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The event type to send as a sample delivery.
+        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"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/webhook_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      # @see OpenAI::Resources::Webhooks#delete
+      class WebhookDeleteParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute webhook_endpoint_id
+        #
+        #   @return [String]
+        required :webhook_endpoint_id, String
+
+        # @!method initialize(webhook_endpoint_id:, request_options: {})
+        #   @param webhook_endpoint_id [String]
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/webhook_endpoint.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      # @see OpenAI::Resources::Webhooks#retrieve
+      class WebhookEndpoint < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the webhook endpoint.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp when the endpoint was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute event_types
+        #   The event types that trigger deliveries to this endpoint.
+        #
+        #   @return [Array<String>]
+        required :event_types, OpenAI::Internal::Type::ArrayOf[String]
+
+        # @!attribute name
+        #   The human-readable name of the endpoint.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute object
+        #   The object type, which is always webhook_endpoint.
+        #
+        #   @return [Symbol, :webhook_endpoint]
+        required :object, const: :webhook_endpoint
+
+        # @!attribute signing_secret_hint
+        #   A masked hint for the endpoint's signing secret.
+        #
+        #   @return [String, nil]
+        required :signing_secret_hint, String, nil?: true
+
+        # @!attribute url
+        #   The HTTPS URL that receives webhook deliveries.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute updated_at
+        #   The Unix timestamp of the last endpoint configuration or signing-secret change.
+        #   Initialized at creation; tests and unchanged updates do not advance it.
+        #
+        #   @return [Integer, nil]
+        optional :updated_at, Integer
+
+        # @!method initialize(id:, created_at:, event_types:, name:, signing_secret_hint:, url:, updated_at: nil, object: :webhook_endpoint)
+        #   @param id [String]
+        #     The unique ID of the webhook endpoint.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp when the endpoint was created.
+        #
+        #   @param event_types [Array<String>]
+        #     The event types that trigger deliveries to this endpoint.
+        #
+        #   @param name [String]
+        #     The human-readable name of the endpoint.
+        #
+        #   @param signing_secret_hint [String, nil]
+        #     A masked hint for the endpoint's signing secret.
+        #
+        #   @param url [String]
+        #     The HTTPS URL that receives webhook deliveries.
+        #
+        #   @param updated_at [Integer]
+        #     The Unix timestamp of the last endpoint configuration or signing-secret change.
+        #     Initialized at creation; tests and unchanged updates do not advance it.
+        #
+        #   @param object [Symbol, :webhook_endpoint]
+        #     The object type, which is always webhook_endpoint.
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/webhook_endpoint_list.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class WebhookEndpointList < OpenAI::Internal::Type::BaseModel
+        # @!attribute data
+        #   The webhook endpoints in this page.
+        #
+        #   @return [Array<OpenAI::Models::Webhooks::WebhookEndpoint>]
+        required :data, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Webhooks::WebhookEndpoint] }
+
+        # @!attribute first_id
+        #   The ID of the first endpoint in this page.
+        #
+        #   @return [String, nil]
+        required :first_id, String, nil?: true
+
+        # @!attribute has_more
+        #   Whether more webhook endpoints are available.
+        #
+        #   @return [Boolean]
+        required :has_more, OpenAI::Internal::Type::Boolean
+
+        # @!attribute last_id
+        #   The ID of the last endpoint in this page.
+        #
+        #   @return [String, nil]
+        required :last_id, String, nil?: true
+
+        # @!attribute object
+        #   The object type, which is always list.
+        #
+        #   @return [Symbol, :list]
+        required :object, const: :list
+
+        # @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
+        #   @param data [Array<OpenAI::Models::Webhooks::WebhookEndpoint>]
+        #     The webhook endpoints in this page.
+        #
+        #   @param first_id [String, nil]
+        #     The ID of the first endpoint in this page.
+        #
+        #   @param has_more [Boolean]
+        #     Whether more webhook endpoints are available.
+        #
+        #   @param last_id [String, nil]
+        #     The ID of the last endpoint in this page.
+        #
+        #   @param object [Symbol, :list]
+        #     The object type, which is always list.
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/webhook_endpoint_test_result.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      # @see OpenAI::Resources::Webhooks#test_
+      class WebhookEndpointTestResult < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_type
+        #   The event type sent in the test.
+        #
+        #   @return [String]
+        required :event_type, String
+
+        # @!attribute object
+        #   The object type, which is always webhook_endpoint.test.
+        #
+        #   @return [Symbol, :"webhook_endpoint.test"]
+        required :object, const: :"webhook_endpoint.test"
+
+        # @!attribute status_code
+        #   The HTTP status code returned by the endpoint.
+        #
+        #   @return [Integer]
+        required :status_code, Integer
+
+        # @!attribute success
+        #   Whether the test request completed. Always true for returned results; use
+        #   status_code to determine the endpoint response.
+        #
+        #   @return [Boolean]
+        required :success, OpenAI::Internal::Type::Boolean
+
+        # @!attribute webhook_endpoint_id
+        #   The ID of the webhook endpoint that received the test.
+        #
+        #   @return [String]
+        required :webhook_endpoint_id, String
+
+        # @!method initialize(event_type:, status_code:, success:, webhook_endpoint_id:, object: :"webhook_endpoint.test")
+        #   @param event_type [String]
+        #     The event type sent in the test.
+        #
+        #   @param status_code [Integer]
+        #     The HTTP status code returned by the endpoint.
+        #
+        #   @param success [Boolean]
+        #     Whether the test request completed. Always true for returned results; use
+        #     status_code to determine the endpoint response.
+        #
+        #   @param webhook_endpoint_id [String]
+        #     The ID of the webhook endpoint that received the test.
+        #
+        #   @param object [Symbol, :"webhook_endpoint.test"]
+        #     The object type, which is always webhook_endpoint.test.
+      end
+    end
+  end
+end