imagekitio 4.7.0 → 4.9.0

data/rbi/imagekitio/models/custom_metadata_field.rbi

@@ -32,13 +32,23 @@ 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
+
       # 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
         ).returns(T.attached_class)
       end
       def self.new(
@@ -52,7 +62,11 @@ 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
       )
       end
 
@@ -62,7 +76,8 @@ module Imagekitio
             id: String,
             label: String,
             name: String,
-            schema: Imagekitio::CustomMetadataField::Schema
+            schema: Imagekitio::CustomMetadataField::Schema,
+            description: String
           }
         )
       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

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.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/accounts/usage.rbi

@@ -8,6 +8,12 @@ module Imagekitio
         # includes data from the start date while excluding data from the end date. In
         # other words, the data covers the period starting from the specified start date
         # up to, but not including, the end date.
+        #
+        # For an agency account, the returned usage is aggregated across the agency and
+        # all of its child accounts that are billed to it.
+        #
+        # The response is cached for 6 hours per account, date range and requested
+        # metrics.
         sig do
           params(
             end_date: Date,

data/rbi/imagekitio/resources/accounts/usage_analytics.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Imagekitio
+  module Resources
+    class Accounts
+      class UsageAnalytics
+        # **Note:** This API is currently in beta.
+        #
+        # Get the account analytics data between two dates. The response covers the period
+        # from the start date to the end date, both dates inclusive. Both dates are
+        # interpreted as UTC calendar days.
+        #
+        # The returned data is scoped to the requesting account only. Unlike
+        # `/v1/accounts/usage`, an agency account's analytics are not aggregated across
+        # its child accounts.
+        #
+        # The response is cached for 5 minutes per account and date range. Use
+        # `generatedAt` to check how fresh the returned data is.
+        sig do
+          params(
+            end_date: Date,
+            start_date: Date,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(Imagekitio::Accounts::UsageAnalyticsResponse)
+        end
+        def get(
+          # Specify an `endDate` in `YYYY-MM-DD` format, interpreted as a UTC calendar day.
+          # It should be after the `startDate`. The difference between `startDate` and
+          # `endDate` should be less than 90 days.
+          end_date:,
+          # Specify a `startDate` in `YYYY-MM-DD` format, interpreted as a UTC calendar day.
+          # It should be before the `endDate`. The difference between `startDate` and
+          # `endDate` should be less than 90 days.
+          start_date:,
+          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

@@ -6,6 +6,9 @@ module Imagekitio
       sig { returns(Imagekitio::Resources::Accounts::Usage) }
       attr_reader :usage
 
+      sig { returns(Imagekitio::Resources::Accounts::UsageAnalytics) }
+      attr_reader :usage_analytics
+
       sig { returns(Imagekitio::Resources::Accounts::Origins) }
       attr_reader :origins
 

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