imagekitio 4.9.0 → 4.11.0

data/rbi/imagekitio/models/folder.rbi

@@ -16,6 +16,14 @@ module Imagekitio
       sig { params(created_at: Time).void }
       attr_writer :created_at
 
+      # Details of the user who created the folder. Present only when this information
+      # is available. The `name` is the name of the user at the time of folder creation.
+      sig { returns(T.nilable(Imagekitio::Folder::CreatedBy)) }
+      attr_reader :created_by
+
+      sig { params(created_by: Imagekitio::Folder::CreatedBy::OrHash).void }
+      attr_writer :created_by
+
       # An object with custom metadata for the folder. Returns empty object if no custom
       # metadata is set.
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
@@ -66,6 +74,7 @@ module Imagekitio
       sig do
         params(
           created_at: Time,
+          created_by: Imagekitio::Folder::CreatedBy::OrHash,
           custom_metadata: T::Hash[Symbol, T.anything],
           folder_id: String,
           folder_path: String,
@@ -78,6 +87,9 @@ module Imagekitio
         # Date and time when the folder was created. The date and time is in ISO8601
         # format.
         created_at: nil,
+        # Details of the user who created the folder. Present only when this information
+        # is available. The `name` is the name of the user at the time of folder creation.
+        created_by: nil,
         # An object with custom metadata for the folder. Returns empty object if no custom
         # metadata is set.
         custom_metadata: nil,
@@ -102,6 +114,7 @@ module Imagekitio
         override.returns(
           {
             created_at: Time,
+            created_by: Imagekitio::Folder::CreatedBy,
             custom_metadata: T::Hash[Symbol, T.anything],
             folder_id: String,
             folder_path: String,
@@ -114,6 +127,42 @@ module Imagekitio
       def to_hash
       end
 
+      class CreatedBy < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Imagekitio::Folder::CreatedBy, Imagekitio::Internal::AnyHash)
+          end
+
+        # Email of the user who created the folder.
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        # Name of the user who created the folder.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Details of the user who created the folder. Present only when this information
+        # is available. The `name` is the name of the user at the time of folder creation.
+        sig { params(email: String, name: String).returns(T.attached_class) }
+        def self.new(
+          # Email of the user who created the folder.
+          email: nil,
+          # Name of the user who created the folder.
+          name: nil
+        )
+        end
+
+        sig { override.returns({ email: String, name: String }) }
+        def to_hash
+        end
+      end
+
       # Type of the asset.
       module Type
         extend Imagekitio::Internal::Type::Enum

data/rbi/imagekitio/models/folder_create_event.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderCreateEvent < Imagekitio::Models::BaseWebhookEvent
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FolderCreateEvent, Imagekitio::Internal::AnyHash)
+        end
+
+      # Timestamp of when the event occurred in ISO8601 format.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(Imagekitio::Folder) }
+      attr_reader :data
+
+      sig { params(data: Imagekitio::Folder::OrHash).void }
+      attr_writer :data
+
+      # Type of the webhook event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Triggered when a folder is created, whether explicitly, by copying or moving a
+      # folder, or implicitly when an upload creates missing parent folders. Copying or
+      # moving a folder tree sends one event per folder in the tree.
+      sig do
+        params(
+          created_at: Time,
+          data: Imagekitio::Folder::OrHash,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Timestamp of when the event occurred in ISO8601 format.
+        created_at:,
+        data:,
+        # Type of the webhook event.
+        type: :"folder.created"
+      )
+      end
+
+      sig do
+        override.returns(
+          { created_at: Time, data: Imagekitio::Folder, type: Symbol }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_delete_event.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderDeleteEvent < Imagekitio::Models::BaseWebhookEvent
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FolderDeleteEvent, Imagekitio::Internal::AnyHash)
+        end
+
+      # Timestamp of when the event occurred in ISO8601 format.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(Imagekitio::FolderDeleteEvent::Data) }
+      attr_reader :data
+
+      sig { params(data: Imagekitio::FolderDeleteEvent::Data::OrHash).void }
+      attr_writer :data
+
+      # Type of the webhook event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Triggered when a folder is deleted. Deleting a folder tree sends one event per
+      # folder in the tree; the files inside it send `file.deleted` events and their
+      # versions send `file-version.deleted` events. Moving a folder sends this event
+      # for the old `folderId` and `folder.created` for the new one.
+      sig do
+        params(
+          created_at: Time,
+          data: Imagekitio::FolderDeleteEvent::Data::OrHash,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Timestamp of when the event occurred in ISO8601 format.
+        created_at:,
+        data:,
+        # Type of the webhook event.
+        type: :"folder.deleted"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            created_at: Time,
+            data: Imagekitio::FolderDeleteEvent::Data,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::FolderDeleteEvent::Data,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # The unique `folderId` of the deleted folder.
+        sig { returns(String) }
+        attr_accessor :folder_id
+
+        sig { params(folder_id: String).returns(T.attached_class) }
+        def self.new(
+          # The unique `folderId` of the deleted folder.
+          folder_id:
+        )
+        end
+
+        sig { override.returns({ folder_id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/folder_update_event.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class FolderUpdateEvent < Imagekitio::Models::BaseWebhookEvent
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::FolderUpdateEvent, Imagekitio::Internal::AnyHash)
+        end
+
+      # Timestamp of when the event occurred in ISO8601 format.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(Imagekitio::Folder) }
+      attr_reader :data
+
+      sig { params(data: Imagekitio::Folder::OrHash).void }
+      attr_writer :data
+
+      # Type of the webhook event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Triggered when a folder is updated, for example when its custom metadata changes
+      # or it is renamed. Renaming a folder sends one event per folder in the tree, each
+      # with its new `folderPath`.
+      sig do
+        params(
+          created_at: Time,
+          data: Imagekitio::Folder::OrHash,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Timestamp of when the event occurred in ISO8601 format.
+        created_at:,
+        data:,
+        # Type of the webhook event.
+        type: :"folder.updated"
+      )
+      end
+
+      sig do
+        override.returns(
+          { created_at: Time, data: Imagekitio::Folder, type: Symbol }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/transformation.rbi

@@ -277,6 +277,20 @@ module Imagekitio
       sig { params(default_image: String).void }
       attr_writer :default_image
 
+      # Sets the output image density in dots per inch (DPI). Accepts an integer from 1
+      # to 1200 or an arithmetic expression using the `idn` variable, such as
+      # `idn_mul_2`. For raster images, this updates density metadata without changing
+      # dimensions. For vector images, it controls the DPI used during rasterization.
+      # Cannot be used inside layers. See
+      # [Density](https://imagekit.io/docs/image-optimization#density---dn).
+      sig { returns(T.nilable(Imagekitio::Transformation::Density::Variants)) }
+      attr_reader :density
+
+      sig do
+        params(density: Imagekitio::Transformation::Density::Variants).void
+      end
+      attr_writer :density
+
       # Distorts the shape of an image. Supports two modes:
       #
       # - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of
@@ -685,6 +699,7 @@ module Imagekitio
           crop: Imagekitio::Transformation::Crop::OrSymbol,
           crop_mode: Imagekitio::Transformation::CropMode::OrSymbol,
           default_image: String,
+          density: Imagekitio::Transformation::Density::Variants,
           distort: String,
           dpr: Float,
           duration: Imagekitio::Transformation::Duration::Variants,
@@ -832,6 +847,13 @@ module Imagekitio
         # path. See
         # [Default image](https://imagekit.io/docs/image-transformation#default-image---di).
         default_image: nil,
+        # Sets the output image density in dots per inch (DPI). Accepts an integer from 1
+        # to 1200 or an arithmetic expression using the `idn` variable, such as
+        # `idn_mul_2`. For raster images, this updates density metadata without changing
+        # dimensions. For vector images, it controls the DPI used during rasterization.
+        # Cannot be used inside layers. See
+        # [Density](https://imagekit.io/docs/image-optimization#density---dn).
+        density: nil,
         # Distorts the shape of an image. Supports two modes:
         #
         # - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of
@@ -1028,6 +1050,7 @@ module Imagekitio
             crop: Imagekitio::Transformation::Crop::OrSymbol,
             crop_mode: Imagekitio::Transformation::CropMode::OrSymbol,
             default_image: String,
+            density: Imagekitio::Transformation::Density::Variants,
             distort: String,
             dpr: Float,
             duration: Imagekitio::Transformation::Duration::Variants,
@@ -1361,6 +1384,26 @@ module Imagekitio
         end
       end
 
+      # Sets the output image density in dots per inch (DPI). Accepts an integer from 1
+      # to 1200 or an arithmetic expression using the `idn` variable, such as
+      # `idn_mul_2`. For raster images, this updates density metadata without changing
+      # dimensions. For vector images, it controls the DPI used during rasterization.
+      # Cannot be used inside layers. See
+      # [Density](https://imagekit.io/docs/image-optimization#density---dn).
+      module Density
+        extend Imagekitio::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(Integer, String) }
+
+        sig do
+          override.returns(
+            T::Array[Imagekitio::Transformation::Density::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+
       # Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`.
       # Typically used with startOffset to indicate the length from the start offset.
       # Arithmetic expressions are supported. See

data/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi

@@ -22,7 +22,10 @@ module Imagekitio
             Imagekitio::FileUpdateEvent,
             Imagekitio::FileDeleteEvent,
             Imagekitio::FileVersionCreateEvent,
-            Imagekitio::FileVersionDeleteEvent
+            Imagekitio::FileVersionDeleteEvent,
+            Imagekitio::FolderCreateEvent,
+            Imagekitio::FolderUpdateEvent,
+            Imagekitio::FolderDeleteEvent
           )
         end
 

data/rbi/imagekitio/models/unwrap_webhook_event.rbi

@@ -22,7 +22,10 @@ module Imagekitio
             Imagekitio::FileUpdateEvent,
             Imagekitio::FileDeleteEvent,
             Imagekitio::FileVersionCreateEvent,
-            Imagekitio::FileVersionDeleteEvent
+            Imagekitio::FileVersionDeleteEvent,
+            Imagekitio::FolderCreateEvent,
+            Imagekitio::FolderUpdateEvent,
+            Imagekitio::FolderDeleteEvent
           )
         end
 

data/rbi/imagekitio/models/update_file_request.rbi

@@ -31,6 +31,11 @@ module Imagekitio
         # A key-value data to be associated with the asset. To unset a key, send `null`
         # value for that key. Before setting any custom metadata on an asset you have to
         # create the field using custom metadata fields API.
+        #
+        # To preserve the original creation date of an asset migrated from another system,
+        # set the reserved `_internal_original_created_datetime` key to an ISO 8601 date
+        # string. This key is available once the original creation date setting is enabled
+        # in the media library settings.
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :custom_metadata
 
@@ -135,6 +140,11 @@ module Imagekitio
           # A key-value data to be associated with the asset. To unset a key, send `null`
           # value for that key. Before setting any custom metadata on an asset you have to
           # create the field using custom metadata fields API.
+          #
+          # To preserve the original creation date of an asset migrated from another system,
+          # set the reserved `_internal_original_created_datetime` key to an ISO 8601 date
+          # string. This key is available once the original creation date setting is enabled
+          # in the media library settings.
           custom_metadata: nil,
           # Optional text to describe the contents of the file.
           description: nil,

data/rbi/imagekitio/models.rbi

@@ -80,8 +80,12 @@ module Imagekitio
 
   FolderCopyParams = Imagekitio::Models::FolderCopyParams
 
+  FolderCreateEvent = Imagekitio::Models::FolderCreateEvent
+
   FolderCreateParams = Imagekitio::Models::FolderCreateParams
 
+  FolderDeleteEvent = Imagekitio::Models::FolderDeleteEvent
+
   FolderDeleteParams = Imagekitio::Models::FolderDeleteParams
 
   FolderMoveParams = Imagekitio::Models::FolderMoveParams
@@ -90,6 +94,8 @@ module Imagekitio
 
   Folders = Imagekitio::Models::Folders
 
+  FolderUpdateEvent = Imagekitio::Models::FolderUpdateEvent
+
   GetImageAttributesOptions = Imagekitio::Models::GetImageAttributesOptions
 
   ImageOverlay = Imagekitio::Models::ImageOverlay

data/rbi/imagekitio/resources/accounts/webhooks.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Imagekitio
+  module Resources
+    class Accounts
+      class Webhooks
+        # Creates a new webhook and returns the created object, including the generated
+        # signing `secret`.
+        #
+        # ImageKit sends a `POST` request to the webhook `endpoint` whenever one of the
+        # subscribed `events` occurs. Use the `secret` to verify the signature of each
+        # request. Learn more about [webhooks](https://imagekit.io/docs/webhooks).
+        #
+        # You can create up to 3 webhooks per account.
+        sig do
+          params(
+            endpoint: String,
+            events: T::Array[Imagekitio::Accounts::WebhookEventType::OrSymbol],
+            enabled: T::Boolean,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::Webhook)
+        end
+        def create(
+          # The URL where ImageKit sends webhook events as `POST` requests. Must use the
+          # `http` or `https` protocol, and must be unique across all webhooks for your
+          # account.
+          endpoint:,
+          # The event types this webhook is subscribed to. ImageKit sends a request to the
+          # `endpoint` only for these events.
+          events:,
+          # Whether the webhook is enabled. When `false`, ImageKit doesn't send any events
+          # to the `endpoint`.
+          enabled: nil,
+          request_options: {}
+        )
+        end
+
+        # Updates the webhook identified by `id` and returns the updated object. Only the
+        # fields included in the request body are changed.
+        #
+        # When `events` is provided, it replaces the existing list of subscribed events.
+        # The signing `secret` can't be changed.
+        sig do
+          params(
+            id: String,
+            enabled: T::Boolean,
+            endpoint: String,
+            events: T::Array[Imagekitio::Accounts::WebhookEventType::OrSymbol],
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::Webhook)
+        end
+        def update(
+          # Unique identifier for a webhook.
+          id,
+          # Whether the webhook is enabled. Omit to leave the current value unchanged.
+          enabled: nil,
+          # The URL where ImageKit sends webhook events as `POST` requests. Must use the
+          # `http` or `https` protocol, and must be unique across all webhooks for your
+          # account.
+          endpoint: nil,
+          # The event types this webhook is subscribed to. Replaces the existing list. Omit
+          # to leave the current value unchanged.
+          events: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns an array of all webhooks configured for your account.
+        sig do
+          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
+            T::Array[Imagekitio::Accounts::Webhook]
+          )
+        end
+        def list(request_options: {})
+        end
+
+        # Permanently deletes the webhook identified by `id`. ImageKit stops sending
+        # events to its endpoint.
+        sig do
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Unique identifier for a webhook.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Retrieves the webhook identified by `id`.
+        sig do
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::Webhook)
+        end
+        def get(
+          # Unique identifier for a webhook.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Imagekitio::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/resources/accounts.rbi

@@ -15,6 +15,9 @@ module Imagekitio
       sig { returns(Imagekitio::Resources::Accounts::URLEndpoints) }
       attr_reader :url_endpoints
 
+      sig { returns(Imagekitio::Resources::Accounts::Webhooks) }
+      attr_reader :webhooks
+
       # @api private
       sig { params(client: Imagekitio::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/imagekitio/resources/assets.rbi

@@ -53,6 +53,15 @@ module Imagekitio
         skip: nil,
         # Sort the results by one of the supported fields in ascending or descending
         # order.
+        #
+        # `ASC_ORIGINAL_CREATION_DATE` and `DESC_ORIGINAL_CREATION_DATE` sort files by the
+        # value of the reserved `_internal_original_created_datetime` custom metadata
+        # field (labelled "Original creation date" in the dashboard). This field exists
+        # only after you enable the original creation date setting under the Custom
+        # Metadata tab of the media library settings. Files that have no value set for
+        # this field fall back to their upload time, so migrated assets carrying a
+        # preserved original date and natively uploaded assets are ordered together in a
+        # single timeline.
         sort: nil,
         # Filter results by asset type.
         #

data/rbi/imagekitio/resources/beta/v2/files.rbi

@@ -112,7 +112,11 @@ module Imagekitio
             #   customCoordinates will be removed.
             custom_coordinates: nil,
             # JSON key-value pairs to associate with the asset. Create the custom metadata
-            # fields before setting these values.
+            # fields before setting these values. To preserve the original creation date of an
+            # asset migrated from another system, set the reserved
+            # `_internal_original_created_datetime` key to an ISO 8601 date string. This key
+            # is available once the original creation date setting is enabled in the media
+            # library settings.
             custom_metadata: nil,
             # Optional text to describe the contents of the file.
             description: nil,

data/rbi/imagekitio/resources/custom_metadata_fields.rbi

@@ -24,6 +24,10 @@ module Imagekitio
         label:,
         # API name of the custom metadata field. This should be unique across all
         # (including deleted) custom metadata fields.
+        #
+        # `_internal_original_created_datetime` is a reserved name and cannot be used.
+        # ImageKit creates that field automatically when you enable the original creation
+        # date setting in the media library settings.
         name:,
         schema:,
         # Optional description for the custom metadata field. Can be up to 500 characters.
@@ -100,7 +104,7 @@ module Imagekitio
         params(
           id: String,
           request_options: Imagekitio::RequestOptions::OrHash
-        ).returns(Imagekitio::Models::CustomMetadataFieldDeleteResponse)
+        ).void
       end
       def delete(
         # Should be a valid custom metadata field id.

data/rbi/imagekitio/resources/files/versions.rbi

@@ -28,7 +28,7 @@ module Imagekitio
             version_id: String,
             file_id: String,
             request_options: Imagekitio::RequestOptions::OrHash
-          ).returns(Imagekitio::Models::Files::VersionDeleteResponse)
+          ).void
         end
         def delete(
           # The unique `versionId` of the uploaded file. `versionId` is returned in list and

data/rbi/imagekitio/resources/files.rbi

@@ -66,7 +66,7 @@ module Imagekitio
           source_file_path: String,
           include_file_versions: T::Boolean,
           request_options: Imagekitio::RequestOptions::OrHash
-        ).returns(Imagekitio::Models::FileCopyResponse)
+        ).void
       end
       def copy(
         # Full path to the folder you want to copy the above file into.
@@ -106,7 +106,7 @@ module Imagekitio
           destination_path: String,
           source_file_path: String,
           request_options: Imagekitio::RequestOptions::OrHash
-        ).returns(Imagekitio::Models::FileMoveResponse)
+        ).void
       end
       def move(
         # Full path to the folder you want to move the above file into.
@@ -268,7 +268,11 @@ module Imagekitio
         #   customCoordinates will be removed.
         custom_coordinates: nil,
         # JSON key-value pairs to associate with the asset. Create the custom metadata
-        # fields before setting these values.
+        # fields before setting these values. To preserve the original creation date of an
+        # asset migrated from another system, set the reserved
+        # `_internal_original_created_datetime` key to an ISO 8601 date string. This key
+        # is available once the original creation date setting is enabled in the media
+        # library settings.
         custom_metadata: nil,
         # Optional text to describe the contents of the file.
         description: nil,

data/rbi/imagekitio/resources/folders.rbi

@@ -40,7 +40,7 @@ module Imagekitio
         params(
           folder_path: String,
           request_options: Imagekitio::RequestOptions::OrHash
-        ).returns(Imagekitio::Models::FolderDeleteResponse)
+        ).void
       end
       def delete(
         # Full path to the folder you want to delete. For example `/folder/to/delete/`.

data/rbi/imagekitio/resources/webhooks.rbi

@@ -17,7 +17,10 @@ module Imagekitio
             Imagekitio::FileUpdateEvent,
             Imagekitio::FileDeleteEvent,
             Imagekitio::FileVersionCreateEvent,
-            Imagekitio::FileVersionDeleteEvent
+            Imagekitio::FileVersionDeleteEvent,
+            Imagekitio::FolderCreateEvent,
+            Imagekitio::FolderUpdateEvent,
+            Imagekitio::FolderDeleteEvent
           )
         )
       end
@@ -45,7 +48,10 @@ module Imagekitio
             Imagekitio::FileUpdateEvent,
             Imagekitio::FileDeleteEvent,
             Imagekitio::FileVersionCreateEvent,
-            Imagekitio::FileVersionDeleteEvent
+            Imagekitio::FileVersionDeleteEvent,
+            Imagekitio::FolderCreateEvent,
+            Imagekitio::FolderUpdateEvent,
+            Imagekitio::FolderDeleteEvent
           )
         )
       end