feat(api): add BaseWebhookEvent

stainless-app[bot] · stainless-app[bot] · commit b4c2a8398c1b · 2025-09-02T07:19:39.000Z
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 42
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-3d7da4b8ef2ed30aa32c4fb3e98e498e67402e91aaa5fd4c628fc080bfe82ea1.yml
-openapi_spec_hash: aaa50fcbccec6f2cf1165f34bc6ac886
-config_hash: 9f8a678d9d4d06daec522e8deb49e3ad
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml
+openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a
+config_hash: 4e73c7e12a531edcd1366dab7eccc360
diff --git a/lib/imagekit/models/unsafe_unwrap_webhook_event.rb b/lib/imagekit/models/unsafe_unwrap_webhook_event.rb
@@ -2,31 +2,21 @@
 
 module Imagekit
   module Models
-    # Triggered when a new video transformation request is accepted for processing.
-    # This event confirms that ImageKit has received and queued your transformation
-    # request. Use this for debugging and tracking transformation lifecycle.
     module UnsafeUnwrapWebhookEvent
       extend Imagekit::Internal::Type::Union
 
-      # Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle.
       variant -> { Imagekit::VideoTransformationAcceptedEvent }
 
-      # Triggered when video encoding is finished and the transformed resource is ready to be served. This is the key event to listen for - update your database or CMS flags when you receive this so your application can start showing the transformed video to users.
       variant -> { Imagekit::VideoTransformationReadyEvent }
 
-      # Triggered when an error occurs during video encoding. Listen to this webhook to log error reasons and debug issues. Check your origin and URL endpoint settings if the reason is related to download failure. For other errors, contact ImageKit support.
       variant -> { Imagekit::VideoTransformationErrorEvent }
 
-      # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library.
       variant -> { Imagekit::UploadPreTransformSuccessEvent }
 
-      # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied.
       variant -> { Imagekit::UploadPreTransformErrorEvent }
 
-      # Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event.
       variant -> { Imagekit::UploadPostTransformSuccessEvent }
 
-      # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated.
       variant -> { Imagekit::UploadPostTransformErrorEvent }
 
       # @!method self.variants
diff --git a/lib/imagekit/models/unwrap_webhook_event.rb b/lib/imagekit/models/unwrap_webhook_event.rb
@@ -2,31 +2,21 @@
 
 module Imagekit
   module Models
-    # Triggered when a new video transformation request is accepted for processing.
-    # This event confirms that ImageKit has received and queued your transformation
-    # request. Use this for debugging and tracking transformation lifecycle.
     module UnwrapWebhookEvent
       extend Imagekit::Internal::Type::Union
 
-      # Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle.
       variant -> { Imagekit::VideoTransformationAcceptedEvent }
 
-      # Triggered when video encoding is finished and the transformed resource is ready to be served. This is the key event to listen for - update your database or CMS flags when you receive this so your application can start showing the transformed video to users.
       variant -> { Imagekit::VideoTransformationReadyEvent }
 
-      # Triggered when an error occurs during video encoding. Listen to this webhook to log error reasons and debug issues. Check your origin and URL endpoint settings if the reason is related to download failure. For other errors, contact ImageKit support.
       variant -> { Imagekit::VideoTransformationErrorEvent }
 
-      # Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library.
       variant -> { Imagekit::UploadPreTransformSuccessEvent }
 
-      # Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied.
       variant -> { Imagekit::UploadPreTransformErrorEvent }
 
-      # Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event.
       variant -> { Imagekit::UploadPostTransformSuccessEvent }
 
-      # Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated.
       variant -> { Imagekit::UploadPostTransformErrorEvent }
 
       # @!method self.variants
diff --git a/lib/imagekit/models/upload_post_transform_error_event.rb b/lib/imagekit/models/upload_post_transform_error_event.rb
@@ -31,9 +31,6 @@ class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel
       required :type, const: :"upload.post-transform.error"
 
       # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.error")
-      #   Triggered when a post-transformation fails. The original file remains available,
-      #   but the requested transformation could not be generated.
-      #
       #   @param id [String] Unique identifier for the event.
       #
       #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
diff --git a/lib/imagekit/models/upload_post_transform_success_event.rb b/lib/imagekit/models/upload_post_transform_success_event.rb
@@ -31,10 +31,6 @@ class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel
       required :type, const: :"upload.post-transform.success"
 
       # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.success")
-      #   Triggered when a post-transformation completes successfully. The transformed
-      #   version of the file is now ready and can be accessed via the provided URL. Note
-      #   that each post-transformation generates a separate webhook event.
-      #
       #   @param id [String] Unique identifier for the event.
       #
       #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
diff --git a/lib/imagekit/models/upload_pre_transform_error_event.rb b/lib/imagekit/models/upload_pre_transform_error_event.rb
@@ -31,9 +31,6 @@ class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel
       required :type, const: :"upload.pre-transform.error"
 
       # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.error")
-      #   Triggered when a pre-transformation fails. The file upload may have been
-      #   accepted, but the requested transformation could not be applied.
-      #
       #   @param id [String] Unique identifier for the event.
       #
       #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
diff --git a/lib/imagekit/models/upload_pre_transform_success_event.rb b/lib/imagekit/models/upload_pre_transform_success_event.rb
@@ -32,10 +32,6 @@ class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel
       required :type, const: :"upload.pre-transform.success"
 
       # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.success")
-      #   Triggered when a pre-transformation completes successfully. The file has been
-      #   processed with the requested transformation and is now available in the Media
-      #   Library.
-      #
       #   @param id [String] Unique identifier for the event.
       #
       #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
diff --git a/lib/imagekit/models/video_transformation_accepted_event.rb b/lib/imagekit/models/video_transformation_accepted_event.rb
@@ -32,10 +32,6 @@ class VideoTransformationAcceptedEvent < Imagekit::Internal::Type::BaseModel
       required :type, const: :"video.transformation.accepted"
 
       # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.accepted")
-      #   Triggered when a new video transformation request is accepted for processing.
-      #   This event confirms that ImageKit has received and queued your transformation
-      #   request. Use this for debugging and tracking transformation lifecycle.
-      #
       #   @param id [String] Unique identifier for the event.
       #
       #   @param created_at [Time] Timestamp when the event was created in ISO8601 format.
diff --git a/lib/imagekit/models/video_transformation_error_event.rb b/lib/imagekit/models/video_transformation_error_event.rb
@@ -32,11 +32,6 @@ class VideoTransformationErrorEvent < Imagekit::Internal::Type::BaseModel
       required :type, const: :"video.transformation.error"
 
       # @!method initialize(id:, created_at:, data:, request:, type: :"video.transformation.error")
-      #   Triggered when an error occurs during video encoding. Listen to this webhook to
-      #   log error reasons and debug issues. Check your origin and URL endpoint settings
-      #   if the reason is related to download failure. For other errors, contact ImageKit
-      #   support.
-      #
       #   @param id [String] Unique identifier for the event.
       #
       #   @param created_at [Time] Timestamp when the event was created in ISO8601 format.
diff --git a/lib/imagekit/models/video_transformation_ready_event.rb b/lib/imagekit/models/video_transformation_ready_event.rb
@@ -38,11 +38,6 @@ class VideoTransformationReadyEvent < Imagekit::Internal::Type::BaseModel
       optional :timings, -> { Imagekit::VideoTransformationReadyEvent::Timings }
 
       # @!method initialize(id:, created_at:, data:, request:, timings: nil, type: :"video.transformation.ready")
-      #   Triggered when video encoding is finished and the transformed resource is ready
-      #   to be served. This is the key event to listen for - update your database or CMS
-      #   flags when you receive this so your application can start showing the
-      #   transformed video to users.
-      #
       #   @param id [String] Unique identifier for the event.
       #
       #   @param created_at [Time] Timestamp when the event was created in ISO8601 format.
diff --git a/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi b/rbi/imagekit/models/unsafe_unwrap_webhook_event.rbi
@@ -2,9 +2,6 @@
 
 module Imagekit
   module Models
-    # Triggered when a new video transformation request is accepted for processing.
-    # This event confirms that ImageKit has received and queued your transformation
-    # request. Use this for debugging and tracking transformation lifecycle.
     module UnsafeUnwrapWebhookEvent
       extend Imagekit::Internal::Type::Union
 
diff --git a/rbi/imagekit/models/unwrap_webhook_event.rbi b/rbi/imagekit/models/unwrap_webhook_event.rbi
@@ -2,9 +2,6 @@
 
 module Imagekit
   module Models
-    # Triggered when a new video transformation request is accepted for processing.
-    # This event confirms that ImageKit has received and queued your transformation
-    # request. Use this for debugging and tracking transformation lifecycle.
     module UnwrapWebhookEvent
       extend Imagekit::Internal::Type::Union
 
diff --git a/rbi/imagekit/models/upload_post_transform_error_event.rbi b/rbi/imagekit/models/upload_post_transform_error_event.rbi
@@ -40,8 +40,6 @@ module Imagekit
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # Triggered when a post-transformation fails. The original file remains available,
-      # but the requested transformation could not be generated.
       sig do
         params(
           id: String,
diff --git a/rbi/imagekit/models/upload_post_transform_success_event.rbi b/rbi/imagekit/models/upload_post_transform_success_event.rbi
@@ -42,9 +42,6 @@ module Imagekit
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # Triggered when a post-transformation completes successfully. The transformed
-      # version of the file is now ready and can be accessed via the provided URL. Note
-      # that each post-transformation generates a separate webhook event.
       sig do
         params(
           id: String,
diff --git a/rbi/imagekit/models/upload_pre_transform_error_event.rbi b/rbi/imagekit/models/upload_pre_transform_error_event.rbi
@@ -40,8 +40,6 @@ module Imagekit
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # Triggered when a pre-transformation fails. The file upload may have been
-      # accepted, but the requested transformation could not be applied.
       sig do
         params(
           id: String,
diff --git a/rbi/imagekit/models/upload_pre_transform_success_event.rbi b/rbi/imagekit/models/upload_pre_transform_success_event.rbi
@@ -43,9 +43,6 @@ module Imagekit
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # Triggered when a pre-transformation completes successfully. The file has been
-      # processed with the requested transformation and is now available in the Media
-      # Library.
       sig do
         params(
           id: String,
diff --git a/rbi/imagekit/models/video_transformation_accepted_event.rbi b/rbi/imagekit/models/video_transformation_accepted_event.rbi
@@ -43,9 +43,6 @@ module Imagekit
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # Triggered when a new video transformation request is accepted for processing.
-      # This event confirms that ImageKit has received and queued your transformation
-      # request. Use this for debugging and tracking transformation lifecycle.
       sig do
         params(
           id: String,
diff --git a/rbi/imagekit/models/video_transformation_error_event.rbi b/rbi/imagekit/models/video_transformation_error_event.rbi
@@ -41,10 +41,6 @@ module Imagekit
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # Triggered when an error occurs during video encoding. Listen to this webhook to
-      # log error reasons and debug issues. Check your origin and URL endpoint settings
-      # if the reason is related to download failure. For other errors, contact ImageKit
-      # support.
       sig do
         params(
           id: String,
diff --git a/rbi/imagekit/models/video_transformation_ready_event.rbi b/rbi/imagekit/models/video_transformation_ready_event.rbi
@@ -54,10 +54,6 @@ module Imagekit
       end
       attr_writer :timings
 
-      # Triggered when video encoding is finished and the transformed resource is ready
-      # to be served. This is the key event to listen for - update your database or CMS
-      # flags when you receive this so your application can start showing the
-      # transformed video to users.
       sig do
         params(
           id: String,

Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,6 @@ class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel`
`31`	`31`	`required :type, const: :"upload.post-transform.error"`
`32`	`32`
`33`	`33`	`# @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.error")`
`34`		`- # Triggered when a post-transformation fails. The original file remains available,`
`35`		`- # but the requested transformation could not be generated.`
`36`		`- #`
`37`	`34`	`# @param id [String] Unique identifier for the event.`
`38`	`35`	`#`
`39`	`36`	`# @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.`
Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,6 @@ class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel`
`31`	`31`	`required :type, const: :"upload.pre-transform.error"`
`32`	`32`
`33`	`33`	`# @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.error")`
`34`		`- # Triggered when a pre-transformation fails. The file upload may have been`
`35`		`- # accepted, but the requested transformation could not be applied.`
`36`		`- #`
`37`	`34`	`# @param id [String] Unique identifier for the event.`
`38`	`35`	`#`
`39`	`36`	`# @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.`