feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 42
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml
 openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a
-config_hash: 4e73c7e12a531edcd1366dab7eccc360
+config_hash: 08e12746cdca1c59c897cf2e50893c3c

lib/imagekit.rb

@@ -54,6 +54,7 @@
 require_relative "imagekit/models/accounts/url_endpoint_request"
 require_relative "imagekit/models/file"
 require_relative "imagekit/models/base_overlay"
+require_relative "imagekit/models/base_webhook_event"
 require_relative "imagekit/models/accounts/origin_create_params"
 require_relative "imagekit/models/accounts/origin_delete_params"
 require_relative "imagekit/models/accounts/origin_get_params"

lib/imagekit/models.rb

@@ -45,6 +45,8 @@ module Imagekit
 
   BaseOverlay = Imagekit::Models::BaseOverlay
 
+  BaseWebhookEvent = Imagekit::Models::BaseWebhookEvent
+
   Beta = Imagekit::Models::Beta
 
   Cache = Imagekit::Models::Cache

lib/imagekit/models/base_webhook_event.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Imagekit
+  module Models
+    class BaseWebhookEvent < Imagekit::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute type
+      #   The type of webhook event.
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!method initialize(id:, type:)
+      #   @param id [String] Unique identifier for the event.
+      #
+      #   @param type [String] The type of webhook event.
+    end
+  end
+end

lib/imagekit/models/unsafe_unwrap_webhook_event.rb

@@ -2,21 +2,31 @@
 
 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

lib/imagekit/models/unwrap_webhook_event.rb

@@ -2,21 +2,31 @@
 
 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

lib/imagekit/models/upload_post_transform_error_event.rb

@@ -2,13 +2,7 @@
 
 module Imagekit
   module Models
-    class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel
-      # @!attribute id
-      #   Unique identifier for the event.
-      #
-      #   @return [String]
-      required :id, String
-
+    class UploadPostTransformErrorEvent < Imagekit::Models::BaseWebhookEvent
       # @!attribute created_at
       #   Timestamp of when the event occurred in ISO8601 format.
       #
@@ -30,8 +24,9 @@ class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel
       #   @return [Symbol, :"upload.post-transform.error"]
       required :type, const: :"upload.post-transform.error"
 
-      # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.error")
-      #   @param id [String] Unique identifier for the event.
+      # @!method initialize(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 created_at [Time] Timestamp of when the event occurred in ISO8601 format.
       #
@@ -41,7 +36,6 @@ class UploadPostTransformErrorEvent < Imagekit::Internal::Type::BaseModel
       #
       #   @param type [Symbol, :"upload.post-transform.error"]
 
-      # @see Imagekit::Models::UploadPostTransformErrorEvent#data
       class Data < Imagekit::Internal::Type::BaseModel
         # @!attribute file_id
         #   Unique identifier of the originally uploaded file.
@@ -107,7 +101,6 @@ class Error < Imagekit::Internal::Type::BaseModel
         end
       end
 
-      # @see Imagekit::Models::UploadPostTransformErrorEvent#request
       class Request < Imagekit::Internal::Type::BaseModel
         # @!attribute transformation
         #

lib/imagekit/models/upload_post_transform_success_event.rb

@@ -2,13 +2,7 @@
 
 module Imagekit
   module Models
-    class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel
-      # @!attribute id
-      #   Unique identifier for the event.
-      #
-      #   @return [String]
-      required :id, String
-
+    class UploadPostTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent
       # @!attribute created_at
       #   Timestamp of when the event occurred in ISO8601 format.
       #
@@ -30,8 +24,10 @@ class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel
       #   @return [Symbol, :"upload.post-transform.success"]
       required :type, const: :"upload.post-transform.success"
 
-      # @!method initialize(id:, created_at:, data:, request:, type: :"upload.post-transform.success")
-      #   @param id [String] Unique identifier for the event.
+      # @!method initialize(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 created_at [Time] Timestamp of when the event occurred in ISO8601 format.
       #
@@ -41,7 +37,6 @@ class UploadPostTransformSuccessEvent < Imagekit::Internal::Type::BaseModel
       #
       #   @param type [Symbol, :"upload.post-transform.success"]
 
-      # @see Imagekit::Models::UploadPostTransformSuccessEvent#data
       class Data < Imagekit::Internal::Type::BaseModel
         # @!attribute file_id
         #   Unique identifier of the originally uploaded file.
@@ -69,7 +64,6 @@ class Data < Imagekit::Internal::Type::BaseModel
         #   @param url [String] URL of the generated post-transformation.
       end
 
-      # @see Imagekit::Models::UploadPostTransformSuccessEvent#request
       class Request < Imagekit::Internal::Type::BaseModel
         # @!attribute transformation
         #

lib/imagekit/models/upload_pre_transform_error_event.rb

@@ -2,13 +2,7 @@
 
 module Imagekit
   module Models
-    class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel
-      # @!attribute id
-      #   Unique identifier for the event.
-      #
-      #   @return [String]
-      required :id, String
-
+    class UploadPreTransformErrorEvent < Imagekit::Models::BaseWebhookEvent
       # @!attribute created_at
       #   Timestamp of when the event occurred in ISO8601 format.
       #
@@ -30,8 +24,9 @@ class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel
       #   @return [Symbol, :"upload.pre-transform.error"]
       required :type, const: :"upload.pre-transform.error"
 
-      # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.error")
-      #   @param id [String] Unique identifier for the event.
+      # @!method initialize(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 created_at [Time] Timestamp of when the event occurred in ISO8601 format.
       #
@@ -41,7 +36,6 @@ class UploadPreTransformErrorEvent < Imagekit::Internal::Type::BaseModel
       #
       #   @param type [Symbol, :"upload.pre-transform.error"]
 
-      # @see Imagekit::Models::UploadPreTransformErrorEvent#data
       class Data < Imagekit::Internal::Type::BaseModel
         # @!attribute name
         #   Name of the file.
@@ -91,7 +85,6 @@ class Error < Imagekit::Internal::Type::BaseModel
         end
       end
 
-      # @see Imagekit::Models::UploadPreTransformErrorEvent#request
       class Request < Imagekit::Internal::Type::BaseModel
         # @!attribute transformation
         #   The requested pre-transformation string.

lib/imagekit/models/upload_pre_transform_success_event.rb

@@ -2,13 +2,7 @@
 
 module Imagekit
   module Models
-    class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel
-      # @!attribute id
-      #   Unique identifier for the event.
-      #
-      #   @return [String]
-      required :id, String
-
+    class UploadPreTransformSuccessEvent < Imagekit::Models::BaseWebhookEvent
       # @!attribute created_at
       #   Timestamp of when the event occurred in ISO8601 format.
       #
@@ -31,8 +25,10 @@ class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel
       #   @return [Symbol, :"upload.pre-transform.success"]
       required :type, const: :"upload.pre-transform.success"
 
-      # @!method initialize(id:, created_at:, data:, request:, type: :"upload.pre-transform.success")
-      #   @param id [String] Unique identifier for the event.
+      # @!method initialize(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 created_at [Time] Timestamp of when the event occurred in ISO8601 format.
       #
@@ -42,7 +38,6 @@ class UploadPreTransformSuccessEvent < Imagekit::Internal::Type::BaseModel
       #
       #   @param type [Symbol, :"upload.pre-transform.success"]
 
-      # @see Imagekit::Models::UploadPreTransformSuccessEvent#data
       class Data < Imagekit::Internal::Type::BaseModel
         # @!attribute ai_tags
         #   An array of tags assigned to the uploaded file by auto tagging.
@@ -439,7 +434,6 @@ class VersionInfo < Imagekit::Internal::Type::BaseModel
         end
       end
 
-      # @see Imagekit::Models::UploadPreTransformSuccessEvent#request
       class Request < Imagekit::Internal::Type::BaseModel
         # @!attribute transformation
         #   The requested pre-transformation string.