imagekitio 4.7.0 → 4.8.0

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/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