imagekitio 4.8.0 → 4.10.0

data/lib/imagekitio/resources/named_transformations.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class NamedTransformations
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::NamedTransformationCreateParams} for more details.
+      #
+      # 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.
+      #
+      # @overload create(name:, transformation:, enabled: nil, request_options: {})
+      #
+      # @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}, nil]
+      #
+      # @return [Imagekitio::Models::NamedTransformation]
+      #
+      # @see Imagekitio::Models::NamedTransformationCreateParams
+      def create(params)
+        parsed, options = Imagekitio::NamedTransformationCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/named-transformations",
+          body: parsed,
+          model: Imagekitio::NamedTransformation,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Imagekitio::Models::NamedTransformationUpdateParams} for more details.
+      #
+      # 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.
+      #
+      # @overload update(id, enabled: nil, name: nil, transformation: nil, request_options: {})
+      #
+      # @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}, nil]
+      #
+      # @return [Imagekitio::Models::NamedTransformation]
+      #
+      # @see Imagekitio::Models::NamedTransformationUpdateParams
+      def update(id, params = {})
+        parsed, options = Imagekitio::NamedTransformationUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/named-transformations/%1$s", id],
+          body: parsed,
+          model: Imagekitio::NamedTransformation,
+          options: options
+        )
+      end
+
+      # Returns an array of all named transformations configured for your account.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<Imagekitio::Models::NamedTransformation>]
+      #
+      # @see Imagekitio::Models::NamedTransformationListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "v1/named-transformations",
+          model: Imagekitio::Internal::Type::ArrayOf[Imagekitio::NamedTransformation],
+          options: params[: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.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Unique identifier for a named transformation.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Imagekitio::Models::NamedTransformationDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/named-transformations/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieves the named transformation identified by `id`.
+      #
+      # @overload get(id, request_options: {})
+      #
+      # @param id [String] Unique identifier for a named transformation.
+      #
+      # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Imagekitio::Models::NamedTransformation]
+      #
+      # @see Imagekitio::Models::NamedTransformationGetParams
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/named-transformations/%1$s", id],
+          model: Imagekitio::NamedTransformation,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Imagekitio::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/imagekitio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Imagekitio
-  VERSION = "4.8.0"
+  VERSION = "4.10.0"
 end

data/lib/imagekitio.rb

@@ -149,6 +149,13 @@ require_relative "imagekitio/models/folders/job_get_response"
 require_relative "imagekitio/models/get_image_attributes_options"
 require_relative "imagekitio/models/image_overlay"
 require_relative "imagekitio/models/metadata"
+require_relative "imagekitio/models/named_transformation"
+require_relative "imagekitio/models/named_transformation_create_params"
+require_relative "imagekitio/models/named_transformation_delete_params"
+require_relative "imagekitio/models/named_transformation_get_params"
+require_relative "imagekitio/models/named_transformation_list_params"
+require_relative "imagekitio/models/named_transformation_list_response"
+require_relative "imagekitio/models/named_transformation_update_params"
 require_relative "imagekitio/models/overlay"
 require_relative "imagekitio/models/overlay_position"
 require_relative "imagekitio/models/overlay_timing"
@@ -202,6 +209,7 @@ require_relative "imagekitio/resources/files/metadata"
 require_relative "imagekitio/resources/files/versions"
 require_relative "imagekitio/resources/folders"
 require_relative "imagekitio/resources/folders/job"
+require_relative "imagekitio/resources/named_transformations"
 require_relative "imagekitio/resources/saved_extensions"
 require_relative "imagekitio/resources/webhooks"
 require_relative "imagekitio/helpers/helper"

data/rbi/imagekitio/client.rbi

@@ -36,6 +36,9 @@ module Imagekitio
     sig { returns(Imagekitio::Resources::SavedExtensions) }
     attr_reader :saved_extensions
 
+    sig { returns(Imagekitio::Resources::NamedTransformations) }
+    attr_reader :named_transformations
+
     sig { returns(Imagekitio::Resources::Assets) }
     attr_reader :assets
 

data/rbi/imagekitio/models/asset_list_params.rbi

@@ -236,6 +236,20 @@ module Imagekitio
             :DESC_RELEVANCE,
             Imagekitio::AssetListParams::Sort::TaggedSymbol
           )
+        ASC_DURATION =
+          T.let(:ASC_DURATION, Imagekitio::AssetListParams::Sort::TaggedSymbol)
+        DESC_DURATION =
+          T.let(:DESC_DURATION, Imagekitio::AssetListParams::Sort::TaggedSymbol)
+        ASC_ORIGINAL_CREATION_DATE =
+          T.let(
+            :ASC_ORIGINAL_CREATION_DATE,
+            Imagekitio::AssetListParams::Sort::TaggedSymbol
+          )
+        DESC_ORIGINAL_CREATION_DATE =
+          T.let(
+            :DESC_ORIGINAL_CREATION_DATE,
+            Imagekitio::AssetListParams::Sort::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/imagekitio/models/custom_metadata_field.rbi

@@ -32,13 +32,32 @@ module Imagekitio
       end
       attr_writer :schema
 
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :reserved
+
+      sig { params(reserved: T::Boolean).void }
+      attr_writer :reserved
+
       # Object containing details of a custom metadata field.
       sig do
         params(
           id: String,
           label: String,
           name: String,
-          schema: Imagekitio::CustomMetadataField::Schema::OrHash
+          schema: Imagekitio::CustomMetadataField::Schema::OrHash,
+          description: String,
+          reserved: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -52,7 +71,14 @@ module Imagekitio
         # `customMetadata` (key-value object) for an asset using upload or update API.
         name:,
         # An object that describes the rules for the custom metadata field value.
-        schema:
+        schema:,
+        # 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.
+        description: nil,
+        # Present and set to `true` when the field is reserved. Omitted for regular
+        # fields. Reserved fields cannot be deleted.
+        reserved: nil
       )
       end
 
@@ -62,7 +88,9 @@ module Imagekitio
             id: String,
             label: String,
             name: String,
-            schema: Imagekitio::CustomMetadataField::Schema
+            schema: Imagekitio::CustomMetadataField::Schema,
+            description: String,
+            reserved: T::Boolean
           }
         )
       end

data/rbi/imagekitio/models/custom_metadata_field_create_params.rbi

@@ -36,11 +36,21 @@ module Imagekitio
       end
       attr_writer :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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
       sig do
         params(
           label: String,
           name: String,
           schema: Imagekitio::CustomMetadataFieldCreateParams::Schema::OrHash,
+          description: String,
           request_options: Imagekitio::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -54,6 +64,10 @@ 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
@@ -64,6 +78,7 @@ module Imagekitio
             label: String,
             name: String,
             schema: Imagekitio::CustomMetadataFieldCreateParams::Schema,
+            description: String,
             request_options: Imagekitio::RequestOptions
           }
         )

data/rbi/imagekitio/models/custom_metadata_field_update_params.rbi

@@ -17,6 +17,16 @@ module Imagekitio
       sig { returns(String) }
       attr_accessor :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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
       # 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
@@ -46,6 +56,7 @@ module Imagekitio
       sig do
         params(
           id: String,
+          description: String,
           label: String,
           schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema::OrHash,
           request_options: Imagekitio::RequestOptions::OrHash
@@ -53,6 +64,11 @@ module Imagekitio
       end
       def self.new(
         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
@@ -71,6 +87,7 @@ module Imagekitio
         override.returns(
           {
             id: String,
+            description: String,
             label: String,
             schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema,
             request_options: Imagekitio::RequestOptions

data/rbi/imagekitio/models/named_transformation.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class NamedTransformation < Imagekitio::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Imagekitio::NamedTransformation, Imagekitio::Internal::AnyHash)
+        end
+
+      # Unique identifier for a named transformation.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # ISO 8601 timestamp of when the named transformation was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Whether the named transformation is currently enabled. When set to `false`,
+      # requests using this named transformation fail at delivery time.
+      sig { returns(T::Boolean) }
+      attr_accessor :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(String) }
+      attr_accessor :name
+
+      # The transformation string this named transformation refers to. Learn more about
+      # the [transformation string syntax](https://imagekit.io/docs/transformations).
+      sig { returns(String) }
+      attr_accessor :transformation
+
+      # 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).
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          enabled: T::Boolean,
+          name: String,
+          transformation: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for a named transformation.
+        id:,
+        # ISO 8601 timestamp of when the named transformation was created.
+        created_at:,
+        # Whether the named transformation is currently enabled. When set to `false`,
+        # requests using this named transformation fail at delivery time.
+        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.
+        name:,
+        # The transformation string this named transformation refers to. Learn more about
+        # the [transformation string syntax](https://imagekit.io/docs/transformations).
+        transformation:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            enabled: T::Boolean,
+            name: String,
+            transformation: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/named_transformation_create_params.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class NamedTransformationCreateParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::NamedTransformationCreateParams,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # 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(String) }
+      attr_accessor :name
+
+      # The transformation string this named transformation refers to. Learn more about
+      # the [transformation string syntax](https://imagekit.io/docs/transformations).
+      sig { returns(String) }
+      attr_accessor :transformation
+
+      # Whether the named transformation is currently enabled. When set to `false`,
+      # requests using this named transformation fail at delivery time.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :enabled
+
+      sig { params(enabled: T::Boolean).void }
+      attr_writer :enabled
+
+      sig do
+        params(
+          name: String,
+          transformation: String,
+          enabled: T::Boolean,
+          request_options: Imagekitio::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            transformation: String,
+            enabled: T::Boolean,
+            request_options: Imagekitio::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/named_transformation_delete_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class NamedTransformationDeleteParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::NamedTransformationDeleteParams,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier for a named transformation.
+      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 named transformation.
+        id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: Imagekitio::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/named_transformation_get_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    class NamedTransformationGetParams < Imagekitio::Internal::Type::BaseModel
+      extend Imagekitio::Internal::Type::RequestParameters::Converter
+      include Imagekitio::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Imagekitio::NamedTransformationGetParams,
+            Imagekitio::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier for a named transformation.
+      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 named transformation.
+        id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: Imagekitio::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/named_transformation_list_params.rbi

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

data/rbi/imagekitio/models/named_transformation_list_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    NamedTransformationListResponse =
+      T.let(
+        Imagekitio::Internal::Type::ArrayOf[Imagekitio::NamedTransformation],
+        Imagekitio::Internal::Type::Converter
+      )
+  end
+end