imagekitio 4.6.0 → 4.8.0

data/lib/imagekitio/models/transformation.rb

@@ -144,7 +144,7 @@ module Imagekitio
       #
       #   - `co-color` - Color to apply (e.g., `red`, `blue`, `FF0022`). Default is gray
       #     color.
-      #   - `in-intensity` - Intensity of the color (0-100). Default is 35. See
+      #   - `in-intensity` - Intensity of the color (0-100). Default is 100. See
       #     [Colorize](https://imagekit.io/docs/effects-and-enhancements#colorize---e-colorize).
       #
       #   @return [String, nil]

data/lib/imagekitio/resources/accounts/usage.rb

@@ -12,6 +12,12 @@ module Imagekitio
         # 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.
+        #
         # @overload get(end_date:, start_date:, request_options: {})
         #
         # @param end_date [Date] Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`.

data/lib/imagekitio/resources/accounts/usage_analytics.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Resources
+    class Accounts
+      class UsageAnalytics
+        # Some parameter documentations has been truncated, see
+        # {Imagekitio::Models::Accounts::UsageAnalyticsGetParams} for more details.
+        #
+        # **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.
+        #
+        # @overload get(end_date:, start_date:, request_options: {})
+        #
+        # @param end_date [Date] Specify an `endDate` in `YYYY-MM-DD` format, interpreted as a UTC calendar day.
+        #
+        # @param start_date [Date] Specify a `startDate` in `YYYY-MM-DD` format, interpreted as a UTC calendar day.
+        #
+        # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Imagekitio::Models::Accounts::UsageAnalyticsResponse]
+        #
+        # @see Imagekitio::Models::Accounts::UsageAnalyticsGetParams
+        def get(params)
+          parsed, options = Imagekitio::Accounts::UsageAnalyticsGetParams.dump_request(params)
+          query = Imagekitio::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "v1/accounts/usage-analytics",
+            query: query.transform_keys(end_date: "endDate", start_date: "startDate"),
+            model: Imagekitio::Accounts::UsageAnalyticsResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Imagekitio::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/resources/accounts.rb

@@ -6,6 +6,9 @@ module Imagekitio
       # @return [Imagekitio::Resources::Accounts::Usage]
       attr_reader :usage
 
+      # @return [Imagekitio::Resources::Accounts::UsageAnalytics]
+      attr_reader :usage_analytics
+
       # @return [Imagekitio::Resources::Accounts::Origins]
       attr_reader :origins
 
@@ -18,6 +21,7 @@ module Imagekitio
       def initialize(client:)
         @client = client
         @usage = Imagekitio::Resources::Accounts::Usage.new(client: client)
+        @usage_analytics = Imagekitio::Resources::Accounts::UsageAnalytics.new(client: client)
         @origins = Imagekitio::Resources::Accounts::Origins.new(client: client)
         @url_endpoints = Imagekitio::Resources::Accounts::URLEndpoints.new(client: client)
       end

data/lib/imagekitio/version.rb

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

data/lib/imagekitio.rb

@@ -55,6 +55,7 @@ require_relative "imagekitio/internal/transport/pooled_net_requester"
 require_relative "imagekitio/client"
 require_relative "imagekitio/models/accounts/origin_request"
 require_relative "imagekitio/models/accounts/url_endpoint_request"
+require_relative "imagekitio/models/accounts/request_bandwidth_entry"
 require_relative "imagekitio/models/base_webhook_event"
 require_relative "imagekitio/models/update_file_request"
 require_relative "imagekitio/models/file"
@@ -74,6 +75,8 @@ require_relative "imagekitio/models/accounts/url_endpoint_list_params"
 require_relative "imagekitio/models/accounts/url_endpoint_list_response"
 require_relative "imagekitio/models/accounts/url_endpoint_response"
 require_relative "imagekitio/models/accounts/url_endpoint_update_params"
+require_relative "imagekitio/models/accounts/usage_analytics_get_params"
+require_relative "imagekitio/models/accounts/usage_analytics_response"
 require_relative "imagekitio/models/accounts/usage_get_params"
 require_relative "imagekitio/models/accounts/usage_get_response"
 require_relative "imagekitio/models/ai_tag"
@@ -185,6 +188,7 @@ require_relative "imagekitio/resources/accounts"
 require_relative "imagekitio/resources/accounts/origins"
 require_relative "imagekitio/resources/accounts/url_endpoints"
 require_relative "imagekitio/resources/accounts/usage"
+require_relative "imagekitio/resources/accounts/usage_analytics"
 require_relative "imagekitio/resources/assets"
 require_relative "imagekitio/resources/beta"
 require_relative "imagekitio/resources/beta/v2"

data/rbi/imagekitio/models/accounts/origin_request.rbi

@@ -30,7 +30,7 @@ module Imagekitio
               )
             end
 
-          # Access key for the bucket.
+          # Access key for the bucket. When `useIAMRole` is `true`, send an empty string.
           sig { returns(String) }
           attr_accessor :access_key
 
@@ -42,7 +42,7 @@ module Imagekitio
           sig { returns(String) }
           attr_accessor :name
 
-          # Secret key for the bucket.
+          # Secret key for the bucket. When `useIAMRole` is `true`, send an empty string.
           sig { returns(String) }
           attr_accessor :secret_key
 
@@ -70,6 +70,14 @@ module Imagekitio
           sig { params(prefix: String).void }
           attr_writer :prefix
 
+          # Use IAM role for authentication instead of access/secret keys. When set to
+          # `true`, send an empty string for both `accessKey` and `secretKey`.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :use_iam_role
+
+          sig { params(use_iam_role: T::Boolean).void }
+          attr_writer :use_iam_role
+
           sig do
             params(
               access_key: String,
@@ -79,17 +87,18 @@ module Imagekitio
               base_url_for_canonical_header: String,
               include_canonical_header: T::Boolean,
               prefix: String,
+              use_iam_role: T::Boolean,
               type: Symbol
             ).returns(T.attached_class)
           end
           def self.new(
-            # Access key for the bucket.
+            # Access key for the bucket. When `useIAMRole` is `true`, send an empty string.
             access_key:,
             # S3 bucket name.
             bucket:,
             # Display name of the origin.
             name:,
-            # Secret key for the bucket.
+            # Secret key for the bucket. When `useIAMRole` is `true`, send an empty string.
             secret_key:,
             # URL used in the Canonical header (if enabled).
             base_url_for_canonical_header: nil,
@@ -97,6 +106,9 @@ module Imagekitio
             include_canonical_header: nil,
             # Path prefix inside the bucket.
             prefix: nil,
+            # Use IAM role for authentication instead of access/secret keys. When set to
+            # `true`, send an empty string for both `accessKey` and `secretKey`.
+            use_iam_role: nil,
             type: :S3
           )
           end
@@ -111,7 +123,8 @@ module Imagekitio
                 type: Symbol,
                 base_url_for_canonical_header: String,
                 include_canonical_header: T::Boolean,
-                prefix: String
+                prefix: String,
+                use_iam_role: T::Boolean
               }
             )
           end
@@ -245,7 +258,7 @@ module Imagekitio
               )
             end
 
-          # Access key for the bucket.
+          # Access key for the bucket. When `useIAMRole` is `true`, send an empty string.
           sig { returns(String) }
           attr_accessor :access_key
 
@@ -257,7 +270,7 @@ module Imagekitio
           sig { returns(String) }
           attr_accessor :name
 
-          # Secret key for the bucket.
+          # Secret key for the bucket. When `useIAMRole` is `true`, send an empty string.
           sig { returns(String) }
           attr_accessor :secret_key
 
@@ -285,6 +298,14 @@ module Imagekitio
           sig { params(prefix: String).void }
           attr_writer :prefix
 
+          # Use IAM role for authentication instead of access/secret keys. When set to
+          # `true`, send an empty string for both `accessKey` and `secretKey`.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :use_iam_role
+
+          sig { params(use_iam_role: T::Boolean).void }
+          attr_writer :use_iam_role
+
           sig do
             params(
               access_key: String,
@@ -294,17 +315,18 @@ module Imagekitio
               base_url_for_canonical_header: String,
               include_canonical_header: T::Boolean,
               prefix: String,
+              use_iam_role: T::Boolean,
               type: Symbol
             ).returns(T.attached_class)
           end
           def self.new(
-            # Access key for the bucket.
+            # Access key for the bucket. When `useIAMRole` is `true`, send an empty string.
             access_key:,
             # S3 bucket name.
             bucket:,
             # Display name of the origin.
             name:,
-            # Secret key for the bucket.
+            # Secret key for the bucket. When `useIAMRole` is `true`, send an empty string.
             secret_key:,
             # URL used in the Canonical header (if enabled).
             base_url_for_canonical_header: nil,
@@ -312,6 +334,9 @@ module Imagekitio
             include_canonical_header: nil,
             # Path prefix inside the bucket.
             prefix: nil,
+            # Use IAM role for authentication instead of access/secret keys. When set to
+            # `true`, send an empty string for both `accessKey` and `secretKey`.
+            use_iam_role: nil,
             type: :CLOUDINARY_BACKUP
           )
           end
@@ -326,7 +351,8 @@ module Imagekitio
                 type: Symbol,
                 base_url_for_canonical_header: String,
                 include_canonical_header: T::Boolean,
-                prefix: String
+                prefix: String,
+                use_iam_role: T::Boolean
               }
             )
           end

data/rbi/imagekitio/models/accounts/origin_response.rbi

@@ -56,6 +56,14 @@ module Imagekitio
           sig { params(base_url_for_canonical_header: String).void }
           attr_writer :base_url_for_canonical_header
 
+          # Whether the origin authenticates using an IAM role instead of access/secret
+          # keys.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :use_iam_role
+
+          sig { params(use_iam_role: T::Boolean).void }
+          attr_writer :use_iam_role
+
           # Unique identifier for the origin. This is generated by ImageKit when you create
           # a new origin.
           sig { returns(String) }
@@ -69,6 +77,7 @@ module Imagekitio
               name: String,
               prefix: String,
               base_url_for_canonical_header: String,
+              use_iam_role: T::Boolean,
               type: Symbol
             ).returns(T.attached_class)
           end
@@ -86,6 +95,9 @@ module Imagekitio
             prefix:,
             # URL used in the Canonical header (if enabled).
             base_url_for_canonical_header: nil,
+            # Whether the origin authenticates using an IAM role instead of access/secret
+            # keys.
+            use_iam_role: nil,
             type: :S3
           )
           end
@@ -99,7 +111,8 @@ module Imagekitio
                 name: String,
                 prefix: String,
                 type: Symbol,
-                base_url_for_canonical_header: String
+                base_url_for_canonical_header: String,
+                use_iam_role: T::Boolean
               }
             )
           end
@@ -244,6 +257,14 @@ module Imagekitio
           sig { params(base_url_for_canonical_header: String).void }
           attr_writer :base_url_for_canonical_header
 
+          # Whether the origin authenticates using an IAM role instead of access/secret
+          # keys.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :use_iam_role
+
+          sig { params(use_iam_role: T::Boolean).void }
+          attr_writer :use_iam_role
+
           # Unique identifier for the origin. This is generated by ImageKit when you create
           # a new origin.
           sig { returns(String) }
@@ -257,6 +278,7 @@ module Imagekitio
               name: String,
               prefix: String,
               base_url_for_canonical_header: String,
+              use_iam_role: T::Boolean,
               type: Symbol
             ).returns(T.attached_class)
           end
@@ -274,6 +296,9 @@ module Imagekitio
             prefix:,
             # URL used in the Canonical header (if enabled).
             base_url_for_canonical_header: nil,
+            # Whether the origin authenticates using an IAM role instead of access/secret
+            # keys.
+            use_iam_role: nil,
             type: :CLOUDINARY_BACKUP
           )
           end
@@ -287,7 +312,8 @@ module Imagekitio
                 name: String,
                 prefix: String,
                 type: Symbol,
-                base_url_for_canonical_header: String
+                base_url_for_canonical_header: String,
+                use_iam_role: T::Boolean
               }
             )
           end

data/rbi/imagekitio/models/accounts/request_bandwidth_entry.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      class RequestBandwidthEntry < Imagekitio::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Accounts::RequestBandwidthEntry,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # Total bandwidth used in bytes.
+        sig { returns(Float) }
+        attr_accessor :bandwidth_bytes
+
+        # Number of requests.
+        sig { returns(Float) }
+        attr_accessor :request_count
+
+        sig do
+          params(bandwidth_bytes: Float, request_count: Float).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Total bandwidth used in bytes.
+          bandwidth_bytes:,
+          # Number of requests.
+          request_count:
+        )
+        end
+
+        sig do
+          override.returns({ bandwidth_bytes: Float, request_count: Float })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/imagekitio/models/accounts/usage_analytics_get_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Imagekitio
+  module Models
+    module Accounts
+      class UsageAnalyticsGetParams < Imagekitio::Internal::Type::BaseModel
+        extend Imagekitio::Internal::Type::RequestParameters::Converter
+        include Imagekitio::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Imagekitio::Accounts::UsageAnalyticsGetParams,
+              Imagekitio::Internal::AnyHash
+            )
+          end
+
+        # 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.
+        sig { returns(Date) }
+        attr_accessor :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.
+        sig { returns(Date) }
+        attr_accessor :start_date
+
+        sig do
+          params(
+            end_date: Date,
+            start_date: Date,
+            request_options: Imagekitio::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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
+
+        sig do
+          override.returns(
+            {
+              end_date: Date,
+              start_date: Date,
+              request_options: Imagekitio::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end