imagekitio 4.10.0 → 4.11.0

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/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

data/sig/imagekitio/models/accounts/webhook.rbs

@@ -0,0 +1,52 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type webhook =
+        {
+          id: String,
+          created_at: Time,
+          enabled: bool,
+          endpoint: String,
+          events: ::Array[Imagekitio::Models::Accounts::webhook_event_type],
+          secret: String,
+          updated_at: Time
+        }
+
+      class Webhook < Imagekitio::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor enabled: bool
+
+        attr_accessor endpoint: String
+
+        attr_accessor events: ::Array[Imagekitio::Models::Accounts::webhook_event_type]
+
+        attr_accessor secret: String
+
+        attr_accessor updated_at: Time
+
+        def initialize: (
+          id: String,
+          created_at: Time,
+          enabled: bool,
+          endpoint: String,
+          events: ::Array[Imagekitio::Models::Accounts::webhook_event_type],
+          secret: String,
+          updated_at: Time
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Time,
+          enabled: bool,
+          endpoint: String,
+          events: ::Array[Imagekitio::Models::Accounts::webhook_event_type],
+          secret: String,
+          updated_at: Time
+        }
+      end
+    end
+  end
+end

data/sig/imagekitio/models/accounts/webhook_create_params.rbs

@@ -0,0 +1,40 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type webhook_create_params =
+        {
+          endpoint: String,
+          events: ::Array[Imagekitio::Models::Accounts::webhook_event_type],
+          enabled: bool
+        }
+        & Imagekitio::Internal::Type::request_parameters
+
+      class WebhookCreateParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        attr_accessor endpoint: String
+
+        attr_accessor events: ::Array[Imagekitio::Models::Accounts::webhook_event_type]
+
+        attr_reader enabled: bool?
+
+        def enabled=: (bool) -> bool
+
+        def initialize: (
+          endpoint: String,
+          events: ::Array[Imagekitio::Models::Accounts::webhook_event_type],
+          ?enabled: bool,
+          ?request_options: Imagekitio::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          endpoint: String,
+          events: ::Array[Imagekitio::Models::Accounts::webhook_event_type],
+          enabled: bool,
+          request_options: Imagekitio::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/imagekitio/models/accounts/webhook_delete_params.rbs

@@ -0,0 +1,25 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type webhook_delete_params =
+        { id: String } & Imagekitio::Internal::Type::request_parameters
+
+      class WebhookDeleteParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        def initialize: (
+          id: String,
+          ?request_options: Imagekitio::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          request_options: Imagekitio::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/imagekitio/models/accounts/webhook_event_type.rbs

@@ -0,0 +1,44 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type webhook_event_type =
+        :"video.transformation.accepted"
+        | :"video.transformation.ready"
+        | :"video.transformation.error"
+        | :"upload.pre-transform.success"
+        | :"upload.pre-transform.error"
+        | :"upload.post-transform.success"
+        | :"upload.post-transform.error"
+        | :"file.created"
+        | :"file.updated"
+        | :"file.deleted"
+        | :"file-version.created"
+        | :"file-version.deleted"
+        | :"folder.created"
+        | :"folder.updated"
+        | :"folder.deleted"
+
+      module WebhookEventType
+        extend Imagekitio::Internal::Type::Enum
+
+        VIDEO_TRANSFORMATION_ACCEPTED: :"video.transformation.accepted"
+        VIDEO_TRANSFORMATION_READY: :"video.transformation.ready"
+        VIDEO_TRANSFORMATION_ERROR: :"video.transformation.error"
+        UPLOAD_PRE_TRANSFORM_SUCCESS: :"upload.pre-transform.success"
+        UPLOAD_PRE_TRANSFORM_ERROR: :"upload.pre-transform.error"
+        UPLOAD_POST_TRANSFORM_SUCCESS: :"upload.post-transform.success"
+        UPLOAD_POST_TRANSFORM_ERROR: :"upload.post-transform.error"
+        FILE_CREATED: :"file.created"
+        FILE_UPDATED: :"file.updated"
+        FILE_DELETED: :"file.deleted"
+        FILE_VERSION_CREATED: :"file-version.created"
+        FILE_VERSION_DELETED: :"file-version.deleted"
+        FOLDER_CREATED: :"folder.created"
+        FOLDER_UPDATED: :"folder.updated"
+        FOLDER_DELETED: :"folder.deleted"
+
+        def self?.values: -> ::Array[Imagekitio::Models::Accounts::webhook_event_type]
+      end
+    end
+  end
+end

data/sig/imagekitio/models/accounts/webhook_get_params.rbs

@@ -0,0 +1,25 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type webhook_get_params =
+        { id: String } & Imagekitio::Internal::Type::request_parameters
+
+      class WebhookGetParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        def initialize: (
+          id: String,
+          ?request_options: Imagekitio::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          request_options: Imagekitio::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/imagekitio/models/accounts/webhook_list_params.rbs

@@ -0,0 +1,17 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type webhook_list_params =
+        {  } & Imagekitio::Internal::Type::request_parameters
+
+      class WebhookListParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: Imagekitio::request_opts) -> void
+
+        def to_hash: -> { request_options: Imagekitio::RequestOptions }
+      end
+    end
+  end
+end

data/sig/imagekitio/models/accounts/webhook_list_response.rbs

@@ -0,0 +1,9 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type webhook_list_response = ::Array[Imagekitio::Accounts::Webhook]
+
+      WebhookListResponse: Imagekitio::Internal::Type::Converter
+    end
+  end
+end

data/sig/imagekitio/models/accounts/webhook_update_params.rbs

@@ -0,0 +1,51 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type webhook_update_params =
+        {
+          id: String,
+          enabled: bool,
+          endpoint: String,
+          events: ::Array[Imagekitio::Models::Accounts::webhook_event_type]
+        }
+        & Imagekitio::Internal::Type::request_parameters
+
+      class WebhookUpdateParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_reader enabled: bool?
+
+        def enabled=: (bool) -> bool
+
+        attr_reader endpoint: String?
+
+        def endpoint=: (String) -> String
+
+        attr_reader events: ::Array[Imagekitio::Models::Accounts::webhook_event_type]?
+
+        def events=: (
+          ::Array[Imagekitio::Models::Accounts::webhook_event_type]
+        ) -> ::Array[Imagekitio::Models::Accounts::webhook_event_type]
+
+        def initialize: (
+          id: String,
+          ?enabled: bool,
+          ?endpoint: String,
+          ?events: ::Array[Imagekitio::Models::Accounts::webhook_event_type],
+          ?request_options: Imagekitio::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          enabled: bool,
+          endpoint: String,
+          events: ::Array[Imagekitio::Models::Accounts::webhook_event_type],
+          request_options: Imagekitio::RequestOptions
+        }
+      end
+    end
+  end
+end