imagekitio 4.7.0 → 4.9.0

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/accounts/request_bandwidth_entry.rbs

@@ -0,0 +1,18 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type request_bandwidth_entry =
+        { bandwidth_bytes: Float, request_count: Float }
+
+      class RequestBandwidthEntry < Imagekitio::Internal::Type::BaseModel
+        attr_accessor bandwidth_bytes: Float
+
+        attr_accessor request_count: Float
+
+        def initialize: (bandwidth_bytes: Float, request_count: Float) -> void
+
+        def to_hash: -> { bandwidth_bytes: Float, request_count: Float }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Imagekitio
+  module Models
+    module Accounts
+      type usage_analytics_get_params =
+        { end_date: Date, start_date: Date }
+        & Imagekitio::Internal::Type::request_parameters
+
+      class UsageAnalyticsGetParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        attr_accessor end_date: Date
+
+        attr_accessor start_date: Date
+
+        def initialize: (
+          end_date: Date,
+          start_date: Date,
+          ?request_options: Imagekitio::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          end_date: Date,
+          start_date: Date,
+          request_options: Imagekitio::RequestOptions
+        }
+      end
+    end
+  end
+end