feat(api): dam related webhook events

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 47
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-63aff1629530786015da3c86131afa8a9b60545d488884b77641f1d4b89c6e9d.yml
-openapi_spec_hash: 586d357bd7e5217d240a99e0d83c6d1f
-config_hash: 47cb702ee2cb52c58d803ae39ade9b44
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-1422f7513f230162270b197061e5768c2e0c803b94b8cd03a5e72544ac75a27f.yml
+openapi_spec_hash: 41175e752e6f6ce900b36aecba687fa7
+config_hash: 17e408231b0b01676298010c7405f483

README.md

@@ -55,9 +55,7 @@ gem "imagekitio", "~> 4.3.0"
 ```ruby
 require "imagekitio"
 
-image_kit = Imagekitio::Client.new(
-  private_key: ENV["IMAGEKIT_PRIVATE_KEY"], # This is the default and can be omitted
-)
+image_kit = Imagekitio::Client.new(private_key: "My Private Key")
 
 response = image_kit.files.upload(
   file: Pathname("/path/to/file"),
@@ -573,7 +571,8 @@ You can use the `max_retries` option to configure or disable this:
 ```ruby
 # Configure the default for all requests:
 image_kit = Imagekitio::Client.new(
-  max_retries: 0 # default is 2
+  max_retries: 0, # default is 2
+  private_key: "My Private Key"
 )
 
 # Or, configure per-request:
@@ -591,7 +590,8 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 ```ruby
 # Configure the default for all requests:
 image_kit = Imagekitio::Client.new(
-  timeout: nil # default is 60
+  timeout: nil, # default is 60
+  private_key: "My Private Key"
 )
 
 # Or, configure per-request:

lib/imagekitio.rb

@@ -55,11 +55,11 @@
 require_relative "imagekitio/client"
 require_relative "imagekitio/models/accounts/origin_request"
 require_relative "imagekitio/models/accounts/url_endpoint_request"
+require_relative "imagekitio/models/base_webhook_event"
 require_relative "imagekitio/models/update_file_request"
 require_relative "imagekitio/models/file"
 require_relative "imagekitio/models/src_options"
 require_relative "imagekitio/models/base_overlay"
-require_relative "imagekitio/models/base_webhook_event"
 require_relative "imagekitio/models/accounts/origin_create_params"
 require_relative "imagekitio/models/accounts/origin_delete_params"
 require_relative "imagekitio/models/accounts/origin_get_params"
@@ -91,6 +91,11 @@
 require_relative "imagekitio/models/custom_metadata_field_list_params"
 require_relative "imagekitio/models/custom_metadata_field_list_response"
 require_relative "imagekitio/models/custom_metadata_field_update_params"
+require_relative "imagekitio/models/dam_file_create_event"
+require_relative "imagekitio/models/dam_file_delete_event"
+require_relative "imagekitio/models/dam_file_update_event"
+require_relative "imagekitio/models/dam_file_version_create_event"
+require_relative "imagekitio/models/dam_file_version_delete_event"
 require_relative "imagekitio/models/extension_config"
 require_relative "imagekitio/models/extensions"
 require_relative "imagekitio/models/file_copy_params"

lib/imagekitio/client.rb

@@ -62,16 +62,6 @@ class Client < Imagekitio::Internal::Transport::BaseClient
     # @return [Imagekitio::Helper]
     attr_reader :helper
 
-    # @api private
-    #
-    # @return [Hash{String=>String}]
-    private def auth_headers
-      return {} if @private_key.nil? || @password.nil?
-
-      base64_credentials = ["#{@private_key}:#{@password}"].pack("m0")
-      {"authorization" => "Basic #{base64_credentials}"}
-    end
-
     # @api private
     #
     # @return [Boolean]

lib/imagekitio/internal/transport/base_client.rb

@@ -215,11 +215,6 @@ def initialize(
           @max_retry_delay = max_retry_delay
         end
 
-        # @api private
-        #
-        # @return [Hash{String=>String}]
-        private def auth_headers = {}
-
         # @api private
         #
         # @return [String]
@@ -276,7 +271,6 @@ def initialize(
 
           headers = Imagekitio::Internal::Util.normalized_headers(
             @headers,
-            auth_headers,
             req[:headers].to_h,
             opts[:extra_headers].to_h
           )

lib/imagekitio/models.rb

@@ -61,6 +61,16 @@ module Imagekitio
 
   CustomMetadataFieldUpdateParams = Imagekitio::Models::CustomMetadataFieldUpdateParams
 
+  DamFileCreateEvent = Imagekitio::Models::DamFileCreateEvent
+
+  DamFileDeleteEvent = Imagekitio::Models::DamFileDeleteEvent
+
+  DamFileUpdateEvent = Imagekitio::Models::DamFileUpdateEvent
+
+  DamFileVersionCreateEvent = Imagekitio::Models::DamFileVersionCreateEvent
+
+  DamFileVersionDeleteEvent = Imagekitio::Models::DamFileVersionDeleteEvent
+
   ExtensionConfig = Imagekitio::Models::ExtensionConfig
 
   ExtensionItem = Imagekitio::Models::ExtensionItem

lib/imagekitio/models/dam_file_create_event.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class DamFileCreateEvent < Imagekitio::Models::BaseWebhookEvent
+      # @!attribute created_at
+      #   Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute data
+      #   Object containing details of a file or file version.
+      #
+      #   @return [Imagekitio::Models::File]
+      required :data, -> { Imagekitio::File }
+
+      # @!attribute type
+      #   Type of the webhook event.
+      #
+      #   @return [Symbol, :"file.created"]
+      required :type, const: :"file.created"
+
+      # @!method initialize(created_at:, data:, type: :"file.created")
+      #   Triggered when a file is created.
+      #
+      #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @param data [Imagekitio::Models::File] Object containing details of a file or file version.
+      #
+      #   @param type [Symbol, :"file.created"] Type of the webhook event.
+    end
+  end
+end

lib/imagekitio/models/dam_file_delete_event.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class DamFileDeleteEvent < Imagekitio::Models::BaseWebhookEvent
+      # @!attribute created_at
+      #   Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute data
+      #
+      #   @return [Imagekitio::Models::DamFileDeleteEvent::Data]
+      required :data, -> { Imagekitio::DamFileDeleteEvent::Data }
+
+      # @!attribute type
+      #   Type of the webhook event.
+      #
+      #   @return [Symbol, :"file.deleted"]
+      required :type, const: :"file.deleted"
+
+      # @!method initialize(created_at:, data:, type: :"file.deleted")
+      #   Triggered when a file is deleted.
+      #
+      #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @param data [Imagekitio::Models::DamFileDeleteEvent::Data]
+      #
+      #   @param type [Symbol, :"file.deleted"] Type of the webhook event.
+
+      class Data < Imagekitio::Internal::Type::BaseModel
+        # @!attribute file_id
+        #   The unique `fileId` of the deleted file.
+        #
+        #   @return [String]
+        required :file_id, String, api_name: :fileId
+
+        # @!method initialize(file_id:)
+        #   @param file_id [String] The unique `fileId` of the deleted file.
+      end
+    end
+  end
+end

lib/imagekitio/models/dam_file_update_event.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class DamFileUpdateEvent < Imagekitio::Models::BaseWebhookEvent
+      # @!attribute created_at
+      #   Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute data
+      #   Object containing details of a file or file version.
+      #
+      #   @return [Imagekitio::Models::File]
+      required :data, -> { Imagekitio::File }
+
+      # @!attribute type
+      #   Type of the webhook event.
+      #
+      #   @return [Symbol, :"file.updated"]
+      required :type, const: :"file.updated"
+
+      # @!method initialize(created_at:, data:, type: :"file.updated")
+      #   Triggered when a file is updated.
+      #
+      #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @param data [Imagekitio::Models::File] Object containing details of a file or file version.
+      #
+      #   @param type [Symbol, :"file.updated"] Type of the webhook event.
+    end
+  end
+end

lib/imagekitio/models/dam_file_version_create_event.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class DamFileVersionCreateEvent < Imagekitio::Models::BaseWebhookEvent
+      # @!attribute created_at
+      #   Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute data
+      #
+      #   @return [Object]
+      required :data, Imagekitio::Internal::Type::Unknown
+
+      # @!attribute type
+      #   Type of the webhook event.
+      #
+      #   @return [Symbol, :"file-version.created"]
+      required :type, const: :"file-version.created"
+
+      # @!method initialize(created_at:, data:, type: :"file-version.created")
+      #   Triggered when a file version is created.
+      #
+      #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @param data [Object]
+      #
+      #   @param type [Symbol, :"file-version.created"] Type of the webhook event.
+    end
+  end
+end