imagekitio 4.8.0 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53589b5e387cc2e3919aaea2e515bc77f13f77d81cf9b244ba2b1749868acb8e
-  data.tar.gz: 2b8701182074f45b8e43235229cff8d2112dfc6063a307e97431110a7419a19b
+  metadata.gz: 3c30ed9b6589210d2b0d5c5cac947cdc09a678c5974b4751287991c9c17c3078
+  data.tar.gz: 49416c6585634a0925a298524cf57ec20043c2acd42b37b8de792a70f4d1f2b4
 SHA512:
-  metadata.gz: bc8f6b4f36557e0419313bdb688c243736a3139e9e1095300d0af2f8c2af339858881d51c67b92d41b1b2493d031cdbed69c116fd6a992ba8bacb54ab5f1bdfb
-  data.tar.gz: b4033a82d0f7960904b513ccd4f01cb662698b0abbba368727889a3aee987438c6f78768efe30b577e35f3f249b4d4cde55bad1c3c27b1418030471f719463ac
+  metadata.gz: 2b7ffb1d472b479d128ae5eab7983c7ebdf24e7197dcaa7fa8a95c6015069fe08472b3f7e8378ae8071d442d66bd34884504a7c6388ec00facc9f4ef39b879cf
+  data.tar.gz: 889a5b70b8537fef0a4cce92d97be64c7467bcb58d1d9c35b8d03bb337a756423d207a1a70ae112cca591c007ce55bee1730c2704c21ba31e55c3c6b8802fa31

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.10.0](https://github.com/imagekit-developer/imagekit-ruby/compare/v4.9.0...v4.10.0) (2026-09-16)
+
+
+### Features
+
+* serialize density as dn in SDK URL builders ([7815ad6](https://github.com/imagekit-developer/imagekit-ruby/commit/7815ad6897fc4ed6bd943443a87aede62ed354d9))
+
+## [4.9.0](https://github.com/imagekit-developer/imagekit-ruby/compare/v4.8.0...v4.9.0) (2026-08-15)
+
+
+### Features
+
+* add description field in custom metadata field api ([f86bf8e](https://github.com/imagekit-developer/imagekit-ruby/commit/f86bf8e78a5fc75323bfeb1a529b2e4045a62729))
+* **api:** Named Transformations ([512b517](https://github.com/imagekit-developer/imagekit-ruby/commit/512b517e3c7c7fa22c9a20e0a20715f3381c66ac))
+
+
+### Chores
+
+* change default branch name ([9b3e035](https://github.com/imagekit-developer/imagekit-ruby/commit/9b3e0352461524f45131bc23b5a466116cc26745))
+* move to one repo structure ([c5b6c51](https://github.com/imagekit-developer/imagekit-ruby/commit/c5b6c513b4da32c2426a699c27f90225aae7e346))
+* pin next release ([431111b](https://github.com/imagekit-developer/imagekit-ruby/commit/431111b97b244e213eb0ba6de36a9255c125cbfc))
+
 ## [4.8.0](https://github.com/imagekit-developer/imagekit-ruby/compare/v4.7.0...v4.8.0) (2026-07-14)
 
 

data/README.md

@@ -46,7 +46,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "imagekitio", "~> 4.8.0"
+gem "imagekitio", "~> 4.10.0"
 ```
 
 <!-- x-release-please-end -->
@@ -748,4 +748,4 @@ Ruby 3.2.0 or higher.
 
 ## Contributing
 
-See [the contributing documentation](https://github.com/imagekit-developer/imagekit-ruby/tree/master/CONTRIBUTING.md).
+See [the contributing documentation](https://github.com/imagekit-developer/imagekit-ruby/tree/main/CONTRIBUTING.md).

data/lib/imagekitio/client.rb

@@ -41,6 +41,9 @@ module Imagekitio
     # @return [Imagekitio::Resources::SavedExtensions]
     attr_reader :saved_extensions
 
+    # @return [Imagekitio::Resources::NamedTransformations]
+    attr_reader :named_transformations
+
     # @return [Imagekitio::Resources::Assets]
     attr_reader :assets
 
@@ -149,6 +152,7 @@ module Imagekitio
       @custom_metadata_fields = Imagekitio::Resources::CustomMetadataFields.new(client: self)
       @files = Imagekitio::Resources::Files.new(client: self)
       @saved_extensions = Imagekitio::Resources::SavedExtensions.new(client: self)
+      @named_transformations = Imagekitio::Resources::NamedTransformations.new(client: self)
       @assets = Imagekitio::Resources::Assets.new(client: self)
       @cache = Imagekitio::Resources::Cache.new(client: self)
       @folders = Imagekitio::Resources::Folders.new(client: self)

data/lib/imagekitio/helpers/transformation_utils.rb

@@ -93,6 +93,7 @@ module Imagekitio
       "color_profile" => "cp",
       "colorProfile" => "cp",
       "metadata" => "md",
+      "density" => "dn",
       "opacity" => "o",
       "trim" => "t",
       "zoom" => "z",

data/lib/imagekitio/models/asset_list_params.rb

@@ -131,6 +131,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
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/imagekitio/models/custom_metadata_field.rb

@@ -31,7 +31,22 @@ module Imagekitio
       #   @return [Imagekitio::Models::CustomMetadataField::Schema]
       required :schema, -> { Imagekitio::CustomMetadataField::Schema }
 
-      # @!method initialize(id:, label:, name:, schema:)
+      # @!attribute description
+      #   Optional description of the custom metadata field. Only present when a
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute reserved
+      #   Present and set to `true` when the field is reserved. Omitted for regular
+      #   fields. Reserved fields cannot be deleted.
+      #
+      #   @return [Boolean, nil]
+      optional :reserved, Imagekitio::Internal::Type::Boolean
+
+      # @!method initialize(id:, label:, name:, schema:, description: nil, reserved: nil)
       #   Some parameter documentations has been truncated, see
       #   {Imagekitio::Models::CustomMetadataField} for more details.
       #
@@ -44,6 +59,10 @@ module Imagekitio
       #   @param name [String] API name of the custom metadata field. This becomes the key while setting `custo
       #
       #   @param schema [Imagekitio::Models::CustomMetadataField::Schema] An object that describes the rules for the custom metadata field value.
+      #
+      #   @param description [String] Optional description of the custom metadata field. Only present when a descripti
+      #
+      #   @param reserved [Boolean] Present and set to `true` when the field is reserved. Omitted for regular fields
 
       # @see Imagekitio::Models::CustomMetadataField#schema
       class Schema < Imagekitio::Internal::Type::BaseModel

data/lib/imagekitio/models/custom_metadata_field_create_params.rb

@@ -28,7 +28,15 @@ module Imagekitio
       #   @return [Imagekitio::Models::CustomMetadataFieldCreateParams::Schema]
       required :schema, -> { Imagekitio::CustomMetadataFieldCreateParams::Schema }
 
-      # @!method initialize(label:, name:, schema:, request_options: {})
+      # @!attribute description
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!method initialize(label:, name:, schema:, description: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Imagekitio::Models::CustomMetadataFieldCreateParams} for more details.
       #
@@ -38,6 +46,8 @@ module Imagekitio
       #
       #   @param schema [Imagekitio::Models::CustomMetadataFieldCreateParams::Schema]
       #
+      #   @param description [String] Optional description for the custom metadata field. Can be up to 500 characters.
+      #
       #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
 
       class Schema < Imagekitio::Internal::Type::BaseModel

data/lib/imagekitio/models/custom_metadata_field_update_params.rb

@@ -12,6 +12,15 @@ module Imagekitio
       #   @return [String]
       required :id, String
 
+      # @!attribute description
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
       # @!attribute label
       #   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
@@ -30,12 +39,14 @@ module Imagekitio
       #   @return [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema, nil]
       optional :schema, -> { Imagekitio::CustomMetadataFieldUpdateParams::Schema }
 
-      # @!method initialize(id:, label: nil, schema: nil, request_options: {})
+      # @!method initialize(id:, description: nil, label: nil, schema: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Imagekitio::Models::CustomMetadataFieldUpdateParams} for more details.
       #
       #   @param id [String]
       #
+      #   @param description [String] Optional description for the custom metadata field. Can be up to 500 characters.
+      #
       #   @param label [String] Human readable name of the custom metadata field. This should be unique across a
       #
       #   @param schema [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i

data/lib/imagekitio/models/named_transformation.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class NamedTransformation < Imagekitio::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for a named transformation.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   ISO 8601 timestamp of when the named transformation was created.
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute enabled
+      #   Whether the named transformation is currently enabled. When set to `false`,
+      #   requests using this named transformation fail at delivery time.
+      #
+      #   @return [Boolean]
+      required :enabled, Imagekitio::Internal::Type::Boolean
+
+      # @!attribute name
+      #   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.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute transformation
+      #   The transformation string this named transformation refers to. Learn more about
+      #   the [transformation string syntax](https://imagekit.io/docs/transformations).
+      #
+      #   @return [String]
+      required :transformation, String
+
+      # @!method initialize(id:, created_at:, enabled:, name:, transformation:)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::NamedTransformation} for more details.
+      #
+      #   A named transformation is an alias for a transformation string, letting you
+      #   apply and later update complex transformations without changing your image or
+      #   video URLs. Learn more about
+      #   [named transformations](https://imagekit.io/docs/transformations#named-transformations).
+      #
+      #   @param id [String] Unique identifier for a named transformation.
+      #
+      #   @param created_at [Time] ISO 8601 timestamp of when the named transformation was created.
+      #
+      #   @param enabled [Boolean] Whether the named transformation is currently enabled. When set to `false`, requ
+      #
+      #   @param name [String] Alias for the transformation string, used in URLs as `tr:n-<name>`. This is case
+      #
+      #   @param transformation [String] The transformation string this named transformation refers to. Learn more about
+    end
+  end
+end

data/lib/imagekitio/models/named_transformation_create_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::NamedTransformations#create
+    class NamedTransformationCreateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   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.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute transformation
+      #   The transformation string this named transformation refers to. Learn more about
+      #   the [transformation string syntax](https://imagekit.io/docs/transformations).
+      #
+      #   @return [String]
+      required :transformation, String
+
+      # @!attribute enabled
+      #   Whether the named transformation is currently enabled. When set to `false`,
+      #   requests using this named transformation fail at delivery time.
+      #
+      #   @return [Boolean, nil]
+      optional :enabled, Imagekitio::Internal::Type::Boolean
+
+      # @!method initialize(name:, transformation:, enabled: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::NamedTransformationCreateParams} for more details.
+      #
+      #   @param name [String] Alias for the transformation string, used in URLs as `tr:n-<name>`. This is case
+      #
+      #   @param transformation [String] The transformation string this named transformation refers to. Learn more about
+      #
+      #   @param enabled [Boolean] Whether the named transformation is currently enabled. When set to `false`, requ
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/named_transformation_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::NamedTransformations#delete
+    class NamedTransformationDeleteParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   Unique identifier for a named transformation.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] Unique identifier for a named transformation.
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/named_transformation_get_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::NamedTransformations#get
+    class NamedTransformationGetParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   Unique identifier for a named transformation.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] Unique identifier for a named transformation.
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/named_transformation_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::NamedTransformations#list
+    class NamedTransformationListParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/named_transformation_list_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @type [Imagekitio::Internal::Type::Converter]
+    NamedTransformationListResponse =
+      Imagekitio::Internal::Type::ArrayOf[-> { Imagekitio::NamedTransformation }]
+  end
+end

data/lib/imagekitio/models/named_transformation_update_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @see Imagekitio::Resources::NamedTransformations#update
+    class NamedTransformationUpdateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   Unique identifier for a named transformation.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute enabled
+      #   Whether the named transformation is enabled. Omit to leave the current value
+      #   unchanged.
+      #
+      #   @return [Boolean, nil]
+      optional :enabled, Imagekitio::Internal::Type::Boolean
+
+      # @!attribute name
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute transformation
+      #   The transformation string this named transformation refers to. Learn more about
+      #   the [transformation string syntax](https://imagekit.io/docs/transformations).
+      #
+      #   @return [String, nil]
+      optional :transformation, String
+
+      # @!method initialize(id:, enabled: nil, name: nil, transformation: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::NamedTransformationUpdateParams} for more details.
+      #
+      #   @param id [String] Unique identifier for a named transformation.
+      #
+      #   @param enabled [Boolean] Whether the named transformation is enabled. Omit to leave the current value unc
+      #
+      #   @param name [String] Alias for the transformation string, used in URLs as `tr:n-<name>`. This is case
+      #
+      #   @param transformation [String] The transformation string this named transformation refers to. Learn more about
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/imagekitio/models/transformation.rb

@@ -201,6 +201,17 @@ module Imagekitio
       #   @return [String, nil]
       optional :default_image, String, api_name: :defaultImage
 
+      # @!attribute density
+      #   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).
+      #
+      #   @return [Integer, String, nil]
+      optional :density, union: -> { Imagekitio::Transformation::Density }
+
       # @!attribute distort
       #   Distorts the shape of an image. Supports two modes:
       #
@@ -510,7 +521,7 @@ module Imagekitio
       #   @return [Float, nil]
       optional :zoom, Float
 
-      # @!method initialize(ai_change_background: nil, ai_drop_shadow: nil, ai_edit: nil, ai_remove_background: nil, ai_remove_background_external: nil, ai_retouch: nil, ai_upscale: nil, ai_variation: nil, aspect_ratio: nil, audio_codec: nil, background: nil, blur: nil, border: nil, colorize: nil, color_profile: nil, color_replace: nil, contrast_stretch: nil, crop: nil, crop_mode: nil, default_image: nil, distort: nil, dpr: nil, duration: nil, end_offset: nil, flip: nil, focus: nil, format_: nil, gradient: nil, grayscale: nil, height: nil, lossless: nil, metadata: nil, named: nil, opacity: nil, original: nil, overlay: nil, page: nil, progressive: nil, quality: nil, radius: nil, raw: nil, rotation: nil, shadow: nil, sharpen: nil, start_offset: nil, streaming_resolutions: nil, trim: nil, unsharp_mask: nil, video_codec: nil, width: nil, x: nil, x_center: nil, y_: nil, y_center: nil, zoom: nil)
+      # @!method initialize(ai_change_background: nil, ai_drop_shadow: nil, ai_edit: nil, ai_remove_background: nil, ai_remove_background_external: nil, ai_retouch: nil, ai_upscale: nil, ai_variation: nil, aspect_ratio: nil, audio_codec: nil, background: nil, blur: nil, border: nil, colorize: nil, color_profile: nil, color_replace: nil, contrast_stretch: nil, crop: nil, crop_mode: nil, default_image: nil, density: nil, distort: nil, dpr: nil, duration: nil, end_offset: nil, flip: nil, focus: nil, format_: nil, gradient: nil, grayscale: nil, height: nil, lossless: nil, metadata: nil, named: nil, opacity: nil, original: nil, overlay: nil, page: nil, progressive: nil, quality: nil, radius: nil, raw: nil, rotation: nil, shadow: nil, sharpen: nil, start_offset: nil, streaming_resolutions: nil, trim: nil, unsharp_mask: nil, video_codec: nil, width: nil, x: nil, x_center: nil, y_: nil, y_center: nil, zoom: nil)
       #   Some parameter documentations has been truncated, see
       #   {Imagekitio::Models::Transformation} for more details.
       #
@@ -561,6 +572,8 @@ module Imagekitio
       #
       #   @param default_image [String] Specifies a fallback image if the resource is not found, e.g., a URL or file pat
       #
+      #   @param density [Integer, String] Sets the output image density in dots per inch (DPI). Accepts an integer from 1
+      #
       #   @param distort [String] Distorts the shape of an image. Supports two modes:
       #
       #   @param dpr [Float] Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DP
@@ -802,6 +815,25 @@ module Imagekitio
         #   @return [Array<Symbol>]
       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).
+      #
+      # @see Imagekitio::Models::Transformation#density
+      module Density
+        extend Imagekitio::Internal::Type::Union
+
+        variant Integer
+
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Integer, String)]
+      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/lib/imagekitio/models.rb

@@ -124,6 +124,18 @@ 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/lib/imagekitio/resources/custom_metadata_fields.rb

@@ -11,7 +11,7 @@ module Imagekitio
       # on the assets. The value of a field for an asset can be set using the media
       # library UI or programmatically through upload or update assets API.
       #
-      # @overload create(label:, name:, schema:, request_options: {})
+      # @overload create(label:, name:, schema:, description: nil, request_options: {})
       #
       # @param label [String] Human readable name of the custom metadata field. This should be unique across a
       #
@@ -19,6 +19,8 @@ module Imagekitio
       #
       # @param schema [Imagekitio::Models::CustomMetadataFieldCreateParams::Schema]
       #
+      # @param description [String] Optional description for the custom metadata field. Can be up to 500 characters.
+      #
       # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Imagekitio::Models::CustomMetadataField]
@@ -38,12 +40,15 @@ module Imagekitio
       # Some parameter documentations has been truncated, see
       # {Imagekitio::Models::CustomMetadataFieldUpdateParams} for more details.
       #
-      # 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.
       #
-      # @overload update(id, label: nil, schema: nil, request_options: {})
+      # @overload update(id, description: nil, label: nil, schema: nil, request_options: {})
       #
       # @param id [String] Should be a valid custom metadata field id.
       #
+      # @param description [String] Optional description for the custom metadata field. Can be up to 500 characters.
+      #
       # @param label [String] Human readable name of the custom metadata field. This should be unique across a
       #
       # @param schema [Imagekitio::Models::CustomMetadataFieldUpdateParams::Schema] An object that describes the rules for the custom metadata key. This parameter i