summaryrefslogtreecommitdiffhomepage
path: root/lib/dispatch/adapter/interface/usage_report.rb
blob: 132c484ffa95d0ae3cdf467f42e0fdc66bffde07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# frozen_string_literal: true

module Dispatch
  module Adapter
    UsageWindow = Struct.new(:id, :label, :duration_ms, :resets_at, keyword_init: true) do
      def initialize(id:, label:, duration_ms: nil, resets_at: nil)
        super
      end
    end

    UsageAmount = Struct.new(
      :used, :limit, :remaining,
      :used_fraction, :remaining_fraction,
      :unit, keyword_init: true
    ) do
      # unit ∈ :percent | :tokens | :requests | :usd | :minutes | :bytes | :unknown
      def initialize(unit:, used: nil, limit: nil, remaining: nil,
                     used_fraction: nil, remaining_fraction: nil)
        super
      end
    end

    UsageLimitEntry = Struct.new(
      :id, :label, :scope, :window, :amount, :status, :notes,
      keyword_init: true
    ) do
      # status ∈ :ok | :warning | :exhausted | :unknown
      def initialize(id:, label:, scope:, amount:, window: nil,
                     status: :unknown, notes: [])
        super
      end
    end

    UsageReport = Struct.new(
      :provider, :fetched_at, :limits, :metadata, :raw,
      keyword_init: true
    ) do
      def initialize(provider:, limits:, fetched_at: Time.now, metadata: {}, raw: nil)
        super
      end
    end
  end
end