imagekitio 4.10.0 → 4.11.0

data/rbi/imagekitio/models/accounts/webhook_event_type.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      # A webhook event type. Learn more about the payload of each
+      # [webhook event](https://imagekit.io/docs/webhooks#list-of-events).
+      module WebhookEventType
+        extend Imagekitio::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Imagekitio::Accounts::WebhookEventType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        VIDEO_TRANSFORMATION_ACCEPTED =
+          T.let(
+            :"video.transformation.accepted",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        VIDEO_TRANSFORMATION_READY =
+          T.let(
+            :"video.transformation.ready",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        VIDEO_TRANSFORMATION_ERROR =
+          T.let(
+            :"video.transformation.error",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        UPLOAD_PRE_TRANSFORM_SUCCESS =
+          T.let(
+            :"upload.pre-transform.success",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        UPLOAD_PRE_TRANSFORM_ERROR =
+          T.let(
+            :"upload.pre-transform.error",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        UPLOAD_POST_TRANSFORM_SUCCESS =
+          T.let(
+            :"upload.post-transform.success",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        UPLOAD_POST_TRANSFORM_ERROR =
+          T.let(
+            :"upload.post-transform.error",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        FILE_CREATED =
+          T.let(
+            :"file.created",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        FILE_UPDATED =
+          T.let(
+            :"file.updated",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        FILE_DELETED =
+          T.let(
+            :"file.deleted",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        FILE_VERSION_CREATED =
+          T.let(
+            :"file-version.created",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        FILE_VERSION_DELETED =
+          T.let(
+            :"file-version.deleted",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        FOLDER_CREATED =
+          T.let(
+            :"folder.created",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        FOLDER_UPDATED =
+          T.let(
+            :"folder.updated",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+        FOLDER_DELETED =
+          T.let(
+            :"folder.deleted",
+            Imagekitio::Accounts::WebhookEventType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Imagekitio::Accounts::WebhookEventType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/accounts/webhook_get_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      class WebhookGetParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Accounts::WebhookGetParams,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for a webhook.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          params(
+            id: String,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for a webhook.
+          id:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, request_options: Imagekitio::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/accounts/webhook_list_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      class WebhookListParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Accounts::WebhookListParams,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Imagekitio::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig do
+          override.returns({ request_options: Imagekitio::RequestOptions })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/accounts/webhook_list_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      WebhookListResponse =
+        T.let(
+          Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::Webhook],
+          Imagekitio::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/imagekitio/models/accounts/webhook_update_params.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      class WebhookUpdateParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Accounts::WebhookUpdateParams,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for a webhook.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Whether the webhook is enabled. Omit to leave the current value unchanged.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :enabled
+
+        sig { params(enabled: T::Boolean).void }
+        attr_writer :enabled
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_reader :endpoint
+
+        sig { params(endpoint: String).void }
+        attr_writer :endpoint
+
+        # The event types this webhook is subscribed to. Replaces the existing list. Omit
+        # to leave the current value unchanged.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Imagekitio::Accounts::WebhookEventType::OrSymbol]
+            )
+          )
+        end
+        attr_reader :events
+
+        sig do
+          params(
+            events: T::Array[Imagekitio::Accounts::WebhookEventType::OrSymbol]
+          ).void
+        end
+        attr_writer :events
+
+        sig do
+          params(
+            id: String,
+            enabled: T::Boolean,
+            endpoint: String,
+            events: T::Array[Imagekitio::Accounts::WebhookEventType::OrSymbol],
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              enabled: T::Boolean,
+              endpoint: String,
+              events:
+                T::Array[Imagekitio::Accounts::WebhookEventType::OrSymbol],
+              request_options: Imagekitio::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/asset_list_params.rbi

@@ -73,6 +73,15 @@ module Imagekitio
 
       # 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.
       sig { returns(T.nilable(Imagekitio::AssetListParams::Sort::OrSymbol)) }
       attr_reader :sort
 
@@ -137,6 +146,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.
         #
@@ -198,6 +216,15 @@ module Imagekitio
 
       # 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.
       module Sort
         extend Imagekitio::Internal::Type::Enum
 

data/rbi/imagekitio/models/beta/v2/file_upload_params.rbi

@@ -75,7 +75,11 @@ module Imagekitio
           attr_writer :custom_coordinates
 
           # 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.
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_reader :custom_metadata
 
@@ -349,7 +353,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/models/custom_metadata_field.rbi

@@ -41,8 +41,21 @@ module Imagekitio
       sig { params(description: String).void }
       attr_writer :description
 
-      # Present and set to `true` when the field is reserved. Omitted for regular
-      # fields. Reserved fields cannot be deleted.
+      # Present and set to `true` when the field is reserved, i.e. created and managed
+      # by ImageKit rather than by you. Omitted for regular fields.
+      #
+      # Currently the only reserved field is `_internal_original_created_datetime`
+      # (label "Original creation date", type `Date`). ImageKit creates it when you
+      # enable the original creation date setting under the Custom Metadata tab of the
+      # media library settings in the dashboard. Use it to preserve the original
+      # creation date of assets migrated from another system: set its value through the
+      # `customMetadata` object in the upload or update file details API, then sort with
+      # `ASC_ORIGINAL_CREATION_DATE` or `DESC_ORIGINAL_CREATION_DATE` in the list and
+      # search assets API, or filter with
+      # `"customMetadata._internal_original_created_datetime"` in `searchQuery`.
+      #
+      # Reserved fields cannot be deleted, and their name cannot be reused when creating
+      # a new field.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :reserved
 
@@ -76,8 +89,21 @@ module Imagekitio
         # description has been set. Shown as a hint to the users while setting the field's
         # value on an asset in the media library UI.
         description: nil,
-        # Present and set to `true` when the field is reserved. Omitted for regular
-        # fields. Reserved fields cannot be deleted.
+        # Present and set to `true` when the field is reserved, i.e. created and managed
+        # by ImageKit rather than by you. Omitted for regular fields.
+        #
+        # Currently the only reserved field is `_internal_original_created_datetime`
+        # (label "Original creation date", type `Date`). ImageKit creates it when you
+        # enable the original creation date setting under the Custom Metadata tab of the
+        # media library settings in the dashboard. Use it to preserve the original
+        # creation date of assets migrated from another system: set its value through the
+        # `customMetadata` object in the upload or update file details API, then sort with
+        # `ASC_ORIGINAL_CREATION_DATE` or `DESC_ORIGINAL_CREATION_DATE` in the list and
+        # search assets API, or filter with
+        # `"customMetadata._internal_original_created_datetime"` in `searchQuery`.
+        #
+        # Reserved fields cannot be deleted, and their name cannot be reused when creating
+        # a new field.
         reserved: nil
       )
       end

data/rbi/imagekitio/models/custom_metadata_field_create_params.rbi

@@ -23,6 +23,10 @@ module Imagekitio
 
       # 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.
       sig { returns(String) }
       attr_accessor :name
 
@@ -62,6 +66,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.

data/rbi/imagekitio/models/file_upload_params.rbi

@@ -70,7 +70,11 @@ module Imagekitio
       attr_writer :custom_coordinates
 
       # 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.
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_reader :custom_metadata
 
@@ -371,7 +375,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/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