imagekitio 4.8.0 → 4.10.0

data/rbi/imagekitio/models/named_transformation_update_params.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class NamedTransformationUpdateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::NamedTransformationUpdateParams,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier for a named transformation.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Whether the named transformation 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
+
+      # Alias for the transformation string, used in URLs as `tr:n-<name>`. This is
+      # case-sensitive, contains only alphanumeric characters or `_` (underscore), and
+      # is unique across all named transformations for your account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # The transformation string this named transformation refers to. Learn more about
+      # the [transformation string syntax](https://imagekit.io/docs/transformations).
+      sig { returns(T.nilable(String)) }
+      attr_reader :transformation
+
+      sig { params(transformation: String).void }
+      attr_writer :transformation
+
+      sig do
+        params(
+          id: String,
+          enabled: T::Boolean,
+          name: String,
+          transformation: String,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for a named transformation.
+        id:,
+        # Whether the named transformation is enabled. Omit to leave the current value
+        # unchanged.
+        enabled: nil,
+        # Alias for the transformation string, used in URLs as `tr:n-<name>`. This is
+        # case-sensitive, contains only alphanumeric characters or `_` (underscore), and
+        # is unique across all named transformations for your account.
+        name: nil,
+        # The transformation string this named transformation refers to. Learn more about
+        # the [transformation string syntax](https://imagekit.io/docs/transformations).
+        transformation: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            enabled: T::Boolean,
+            name: String,
+            transformation: String,
+            request_options: Imagekitio::RequestOptions
+          }
+        )
+      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.rbi

@@ -96,6 +96,23 @@ module Imagekitio
 
   Metadata = Imagekitio::Models::Metadata
 
+  NamedTransformation = Imagekitio::Models::NamedTransformation
+
+  NamedTransformationCreateParams =
+    Imagekitio::Models::NamedTransformationCreateParams
+
+  NamedTransformationDeleteParams =
+    Imagekitio::Models::NamedTransformationDeleteParams
+
+  NamedTransformationGetParams =
+    Imagekitio::Models::NamedTransformationGetParams
+
+  NamedTransformationListParams =
+    Imagekitio::Models::NamedTransformationListParams
+
+  NamedTransformationUpdateParams =
+    Imagekitio::Models::NamedTransformationUpdateParams
+
   Overlay = Imagekitio::Models::Overlay
 
   OverlayPosition = Imagekitio::Models::OverlayPosition

data/rbi/imagekitio/resources/custom_metadata_fields.rbi

@@ -12,6 +12,7 @@ module Imagekitio
           label: String,
           name: String,
           schema: Imagekitio::CustomMetadataFieldCreateParams::Schema::OrHash,
+          description: String,
           request_options: Imagekitio::RequestOptions::OrHash
         ).returns(Imagekitio::CustomMetadataField)
       end
@@ -25,14 +26,20 @@ module Imagekitio
         # (including deleted) custom metadata fields.
         name:,
         schema:,
+        # Optional description for the custom metadata field. Can be up to 500 characters.
+        # This is shown as a hint to the users while setting the field's value on an asset
+        # in the media library UI.
+        description: nil,
         request_options: {}
       )
       end
 
-      # This API updates the label or schema of an existing custom metadata field.
+      # This API updates the label, description, or schema of an existing custom
+      # metadata field.
       sig do
         params(
           id: String,
+          description: String,
           label: String,
           schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema::OrHash,
           request_options: Imagekitio::RequestOptions::OrHash
@@ -41,6 +48,11 @@ module Imagekitio
       def update(
         # Should be a valid custom metadata field id.
         id,
+        # Optional description for the custom metadata field. Can be up to 500 characters.
+        # Send an empty string to clear an existing description. This is shown as a hint
+        # to the users while setting the field's value on an asset in the media library
+        # UI.
+        description: nil,
         # Human readable name of the custom metadata field. This should be unique across
         # all non deleted custom metadata fields. This name is displayed as form field
         # label to the users while setting field value on an asset in the media library

data/rbi/imagekitio/resources/named_transformations.rbi

@@ -0,0 +1,119 @@
+# typed: strong
+
+module Imagekitio
+  module Resources
+    class NamedTransformations
+      # Creates a new named transformation and returns the created object.
+      #
+      # A named transformation is a short, reusable name for a transformation string.
+      # Use it in image and video URLs as `tr:n-<name>`, and update the underlying
+      # transformation later without changing existing URLs. Learn more about
+      # [named transformations](https://imagekit.io/docs/transformations#named-transformations).
+      #
+      # You can create up to 250 named transformations per account.
+      sig do
+        params(
+          name: String,
+          transformation: String,
+          enabled: T::Boolean,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(Imagekitio::NamedTransformation)
+      end
+      def create(
+        # Alias for the transformation string, used in URLs as `tr:n-<name>`. This is
+        # case-sensitive, contains only alphanumeric characters or `_` (underscore), and
+        # is unique across all named transformations for your account.
+        name:,
+        # The transformation string this named transformation refers to. Learn more about
+        # the [transformation string syntax](https://imagekit.io/docs/transformations).
+        transformation:,
+        # Whether the named transformation is currently enabled. When set to `false`,
+        # requests using this named transformation fail at delivery time.
+        enabled: nil,
+        request_options: {}
+      )
+      end
+
+      # Updates the named transformation identified by `id` and returns the updated
+      # object. Only the fields present in the request body are updated; other fields
+      # stay unchanged.
+      #
+      # Renaming or disabling a named transformation fails with a `409` error if it is
+      # still referenced (via the `n-<name>` token) by an upload pre-transformation or
+      # post-transformation setting. This check is best-effort and can't detect
+      # references in your own application code or in previously generated URLs.
+      sig do
+        params(
+          id: String,
+          enabled: T::Boolean,
+          name: String,
+          transformation: String,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(Imagekitio::NamedTransformation)
+      end
+      def update(
+        # Unique identifier for a named transformation.
+        id,
+        # Whether the named transformation is enabled. Omit to leave the current value
+        # unchanged.
+        enabled: nil,
+        # Alias for the transformation string, used in URLs as `tr:n-<name>`. This is
+        # case-sensitive, contains only alphanumeric characters or `_` (underscore), and
+        # is unique across all named transformations for your account.
+        name: nil,
+        # The transformation string this named transformation refers to. Learn more about
+        # the [transformation string syntax](https://imagekit.io/docs/transformations).
+        transformation: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns an array of all named transformations configured for your account.
+      sig do
+        params(request_options: Imagekitio::RequestOptions::OrHash).returns(
+          T::Array[Imagekitio::NamedTransformation]
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Permanently deletes the named transformation identified by `id`.
+      #
+      # Deletion fails with a `409` error if the named transformation is still
+      # referenced (via the `n-<name>` token) by an upload pre-transformation or
+      # post-transformation setting. This check is best-effort and can't detect
+      # references in your own application code or in previously generated URLs.
+      sig do
+        params(
+          id: String,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Unique identifier for a named transformation.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Retrieves the named transformation identified by `id`.
+      sig do
+        params(
+          id: String,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(Imagekitio::NamedTransformation)
+      end
+      def get(
+        # Unique identifier for a named transformation.
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Imagekitio::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/imagekitio/client.rbs

@@ -20,6 +20,8 @@ module Imagekitio
 
     attr_reader saved_extensions: Imagekitio::Resources::SavedExtensions
 
+    attr_reader named_transformations: Imagekitio::Resources::NamedTransformations
+
     attr_reader assets: Imagekitio::Resources::Assets
 
     attr_reader cache: Imagekitio::Resources::Cache

data/sig/imagekitio/models/asset_list_params.rbs

@@ -99,6 +99,10 @@ module Imagekitio
         | :DESC_SIZE
         | :ASC_RELEVANCE
         | :DESC_RELEVANCE
+        | :ASC_DURATION
+        | :DESC_DURATION
+        | :ASC_ORIGINAL_CREATION_DATE
+        | :DESC_ORIGINAL_CREATION_DATE
 
       module Sort
         extend Imagekitio::Internal::Type::Enum
@@ -117,6 +121,10 @@ module Imagekitio
         DESC_SIZE: :DESC_SIZE
         ASC_RELEVANCE: :ASC_RELEVANCE
         DESC_RELEVANCE: :DESC_RELEVANCE
+        ASC_DURATION: :ASC_DURATION
+        DESC_DURATION: :DESC_DURATION
+        ASC_ORIGINAL_CREATION_DATE: :ASC_ORIGINAL_CREATION_DATE
+        DESC_ORIGINAL_CREATION_DATE: :DESC_ORIGINAL_CREATION_DATE
 
         def self?.values: -> ::Array[Imagekitio::Models::AssetListParams::sort]
       end

data/sig/imagekitio/models/custom_metadata_field.rbs

@@ -5,7 +5,9 @@ module Imagekitio
         id: String,
         label: String,
         name: String,
-        schema: Imagekitio::CustomMetadataField::Schema
+        schema: Imagekitio::CustomMetadataField::Schema,
+        description: String,
+        reserved: bool
       }
 
     class CustomMetadataField < Imagekitio::Internal::Type::BaseModel
@@ -17,18 +19,30 @@ module Imagekitio
 
       attr_accessor schema: Imagekitio::CustomMetadataField::Schema
 
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader reserved: bool?
+
+      def reserved=: (bool) -> bool
+
       def initialize: (
         id: String,
         label: String,
         name: String,
-        schema: Imagekitio::CustomMetadataField::Schema
+        schema: Imagekitio::CustomMetadataField::Schema,
+        ?description: String,
+        ?reserved: bool
       ) -> void
 
       def to_hash: -> {
         id: String,
         label: String,
         name: String,
-        schema: Imagekitio::CustomMetadataField::Schema
+        schema: Imagekitio::CustomMetadataField::Schema,
+        description: String,
+        reserved: bool
       }
 
       type schema =

data/sig/imagekitio/models/custom_metadata_field_create_params.rbs

@@ -4,7 +4,8 @@ module Imagekitio
       {
         label: String,
         name: String,
-        schema: Imagekitio::CustomMetadataFieldCreateParams::Schema
+        schema: Imagekitio::CustomMetadataFieldCreateParams::Schema,
+        description: String
       }
       & Imagekitio::Internal::Type::request_parameters
 
@@ -18,10 +19,15 @@ module Imagekitio
 
       attr_accessor schema: Imagekitio::CustomMetadataFieldCreateParams::Schema
 
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
       def initialize: (
         label: String,
         name: String,
         schema: Imagekitio::CustomMetadataFieldCreateParams::Schema,
+        ?description: String,
         ?request_options: Imagekitio::request_opts
       ) -> void
 
@@ -29,6 +35,7 @@ module Imagekitio
         label: String,
         name: String,
         schema: Imagekitio::CustomMetadataFieldCreateParams::Schema,
+        description: String,
         request_options: Imagekitio::RequestOptions
       }
 

data/sig/imagekitio/models/custom_metadata_field_update_params.rbs

@@ -3,6 +3,7 @@ module Imagekitio
     type custom_metadata_field_update_params =
       {
         id: String,
+        description: String,
         label: String,
         schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema
       }
@@ -14,6 +15,10 @@ module Imagekitio
 
       attr_accessor id: String
 
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
       attr_reader label: String?
 
       def label=: (String) -> String
@@ -26,6 +31,7 @@ module Imagekitio
 
       def initialize: (
         id: String,
+        ?description: String,
         ?label: String,
         ?schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema,
         ?request_options: Imagekitio::request_opts
@@ -33,6 +39,7 @@ module Imagekitio
 
       def to_hash: -> {
         id: String,
+        description: String,
         label: String,
         schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema,
         request_options: Imagekitio::RequestOptions

data/sig/imagekitio/models/named_transformation.rbs

@@ -0,0 +1,40 @@
+module Imagekitio
+  module Models
+    type named_transformation =
+      {
+        id: String,
+        created_at: Time,
+        enabled: bool,
+        name: String,
+        transformation: String
+      }
+
+    class NamedTransformation < Imagekitio::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor enabled: bool
+
+      attr_accessor name: String
+
+      attr_accessor transformation: String
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        enabled: bool,
+        name: String,
+        transformation: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        enabled: bool,
+        name: String,
+        transformation: String
+      }
+    end
+  end
+end

data/sig/imagekitio/models/named_transformation_create_params.rbs

@@ -0,0 +1,34 @@
+module Imagekitio
+  module Models
+    type named_transformation_create_params =
+      { name: String, transformation: String, enabled: bool }
+      & Imagekitio::Internal::Type::request_parameters
+
+    class NamedTransformationCreateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      attr_accessor name: String
+
+      attr_accessor transformation: String
+
+      attr_reader enabled: bool?
+
+      def enabled=: (bool) -> bool
+
+      def initialize: (
+        name: String,
+        transformation: String,
+        ?enabled: bool,
+        ?request_options: Imagekitio::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        transformation: String,
+        enabled: bool,
+        request_options: Imagekitio::RequestOptions
+      }
+    end
+  end
+end

data/sig/imagekitio/models/named_transformation_delete_params.rbs

@@ -0,0 +1,23 @@
+module Imagekitio
+  module Models
+    type named_transformation_delete_params =
+      { id: String } & Imagekitio::Internal::Type::request_parameters
+
+    class NamedTransformationDeleteParams < 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

data/sig/imagekitio/models/named_transformation_get_params.rbs

@@ -0,0 +1,23 @@
+module Imagekitio
+  module Models
+    type named_transformation_get_params =
+      { id: String } & Imagekitio::Internal::Type::request_parameters
+
+    class NamedTransformationGetParams < 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

data/sig/imagekitio/models/named_transformation_list_params.rbs

@@ -0,0 +1,15 @@
+module Imagekitio
+  module Models
+    type named_transformation_list_params =
+      {  } & Imagekitio::Internal::Type::request_parameters
+
+    class NamedTransformationListParams < 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

data/sig/imagekitio/models/named_transformation_list_response.rbs

@@ -0,0 +1,8 @@
+module Imagekitio
+  module Models
+    type named_transformation_list_response =
+      ::Array[Imagekitio::NamedTransformation]
+
+    NamedTransformationListResponse: Imagekitio::Internal::Type::Converter
+  end
+end

data/sig/imagekitio/models/named_transformation_update_params.rbs

@@ -0,0 +1,42 @@
+module Imagekitio
+  module Models
+    type named_transformation_update_params =
+      { id: String, enabled: bool, name: String, transformation: String }
+      & Imagekitio::Internal::Type::request_parameters
+
+    class NamedTransformationUpdateParams < 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 name: String?
+
+      def name=: (String) -> String
+
+      attr_reader transformation: String?
+
+      def transformation=: (String) -> String
+
+      def initialize: (
+        id: String,
+        ?enabled: bool,
+        ?name: String,
+        ?transformation: String,
+        ?request_options: Imagekitio::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        enabled: bool,
+        name: String,
+        transformation: String,
+        request_options: Imagekitio::RequestOptions
+      }
+    end
+  end
+end