metronome-sdk 0.1.0.pre.alpha.1

data/rbi/metronome_sdk/models/v1/usage_list_params.rbi

@@ -0,0 +1,170 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class UsageListParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        sig { returns(Time) }
+        attr_accessor :ending_before
+
+        sig { returns(Time) }
+        attr_accessor :starting_on
+
+        # A window_size of "day" or "hour" will return the usage for the specified period
+        # segmented into daily or hourly aggregates. A window_size of "none" will return a
+        # single usage aggregate for the entirety of the specified period.
+        sig { returns(MetronomeSDK::Models::V1::UsageListParams::WindowSize::OrSymbol) }
+        attr_accessor :window_size
+
+        # Cursor that indicates where the next page of results should start.
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_page
+
+        sig { params(next_page: String).void }
+        attr_writer :next_page
+
+        # A list of billable metrics to fetch usage for. If absent, all billable metrics
+        # will be returned.
+        sig { returns(T.nilable(T::Array[MetronomeSDK::Models::V1::UsageListParams::BillableMetric])) }
+        attr_reader :billable_metrics
+
+        sig do
+          params(
+            billable_metrics: T::Array[T.any(MetronomeSDK::Models::V1::UsageListParams::BillableMetric, MetronomeSDK::Internal::AnyHash)]
+          )
+            .void
+        end
+        attr_writer :billable_metrics
+
+        # A list of Metronome customer IDs to fetch usage for. If absent, usage for all
+        # customers will be returned.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :customer_ids
+
+        sig { params(customer_ids: T::Array[String]).void }
+        attr_writer :customer_ids
+
+        sig do
+          params(
+            ending_before: Time,
+            starting_on: Time,
+            window_size: MetronomeSDK::Models::V1::UsageListParams::WindowSize::OrSymbol,
+            next_page: String,
+            billable_metrics: T::Array[T.any(MetronomeSDK::Models::V1::UsageListParams::BillableMetric, MetronomeSDK::Internal::AnyHash)],
+            customer_ids: T::Array[String],
+            request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          ending_before:,
+          starting_on:,
+          # A window_size of "day" or "hour" will return the usage for the specified period
+          # segmented into daily or hourly aggregates. A window_size of "none" will return a
+          # single usage aggregate for the entirety of the specified period.
+          window_size:,
+          # Cursor that indicates where the next page of results should start.
+          next_page: nil,
+          # A list of billable metrics to fetch usage for. If absent, all billable metrics
+          # will be returned.
+          billable_metrics: nil,
+          # A list of Metronome customer IDs to fetch usage for. If absent, usage for all
+          # customers will be returned.
+          customer_ids: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                ending_before: Time,
+                starting_on: Time,
+                window_size: MetronomeSDK::Models::V1::UsageListParams::WindowSize::OrSymbol,
+                next_page: String,
+                billable_metrics: T::Array[MetronomeSDK::Models::V1::UsageListParams::BillableMetric],
+                customer_ids: T::Array[String],
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        # A window_size of "day" or "hour" will return the usage for the specified period
+        # segmented into daily or hourly aggregates. A window_size of "none" will return a
+        # single usage aggregate for the entirety of the specified period.
+        module WindowSize
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HOUR = T.let(:HOUR, MetronomeSDK::Models::V1::UsageListParams::WindowSize::TaggedSymbol)
+          DAY = T.let(:DAY, MetronomeSDK::Models::V1::UsageListParams::WindowSize::TaggedSymbol)
+          NONE = T.let(:NONE, MetronomeSDK::Models::V1::UsageListParams::WindowSize::TaggedSymbol)
+
+          sig { override.returns(T::Array[MetronomeSDK::Models::V1::UsageListParams::WindowSize::TaggedSymbol]) }
+          def self.values; end
+        end
+
+        class BillableMetric < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(T.nilable(MetronomeSDK::Models::V1::UsageListParams::BillableMetric::GroupBy)) }
+          attr_reader :group_by
+
+          sig do
+            params(
+              group_by: T.any(MetronomeSDK::Models::V1::UsageListParams::BillableMetric::GroupBy, MetronomeSDK::Internal::AnyHash)
+            )
+              .void
+          end
+          attr_writer :group_by
+
+          sig do
+            params(
+              id: String,
+              group_by: T.any(MetronomeSDK::Models::V1::UsageListParams::BillableMetric::GroupBy, MetronomeSDK::Internal::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(id:, group_by: nil); end
+
+          sig do
+            override
+              .returns({id: String, group_by: MetronomeSDK::Models::V1::UsageListParams::BillableMetric::GroupBy})
+          end
+          def to_hash; end
+
+          class GroupBy < MetronomeSDK::Internal::Type::BaseModel
+            # The name of the group_by key to use
+            sig { returns(String) }
+            attr_accessor :key
+
+            # Values of the group_by key to return in the query. If this field is omitted, all
+            # available values will be returned, up to a maximum of 200.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :values
+
+            sig { params(values: T::Array[String]).void }
+            attr_writer :values
+
+            sig { params(key: String, values: T::Array[String]).returns(T.attached_class) }
+            def self.new(
+              # The name of the group_by key to use
+              key:,
+              # Values of the group_by key to return in the query. If this field is omitted, all
+              # available values will be returned, up to a maximum of 200.
+              values: nil
+            ); end
+            sig { override.returns({key: String, values: T::Array[String]}) }
+            def to_hash; end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/usage_list_response.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class UsageListResponse < MetronomeSDK::Internal::Type::BaseModel
+        sig { returns(T::Array[MetronomeSDK::Models::V1::UsageListResponse::Data]) }
+        attr_accessor :data
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_page
+
+        sig do
+          params(
+            data: T::Array[T.any(MetronomeSDK::Models::V1::UsageListResponse::Data, MetronomeSDK::Internal::AnyHash)],
+            next_page: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(data:, next_page:); end
+
+        sig do
+          override
+            .returns({data: T::Array[MetronomeSDK::Models::V1::UsageListResponse::Data], next_page: T.nilable(String)})
+        end
+        def to_hash; end
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(String) }
+          attr_accessor :billable_metric_id
+
+          sig { returns(String) }
+          attr_accessor :billable_metric_name
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          sig { returns(Time) }
+          attr_accessor :end_timestamp
+
+          sig { returns(Time) }
+          attr_accessor :start_timestamp
+
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :value
+
+          # Values will be either a number or null. Null indicates that there were no
+          # matches for the group_by value.
+          sig { returns(T.nilable(T::Hash[Symbol, T.nilable(Float)])) }
+          attr_reader :groups
+
+          sig { params(groups: T::Hash[Symbol, T.nilable(Float)]).void }
+          attr_writer :groups
+
+          sig do
+            params(
+              billable_metric_id: String,
+              billable_metric_name: String,
+              customer_id: String,
+              end_timestamp: Time,
+              start_timestamp: Time,
+              value: T.nilable(Float),
+              groups: T::Hash[Symbol, T.nilable(Float)]
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            billable_metric_id:,
+            billable_metric_name:,
+            customer_id:,
+            end_timestamp:,
+            start_timestamp:,
+            value:,
+            # Values will be either a number or null. Null indicates that there were no
+            # matches for the group_by value.
+            groups: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  billable_metric_id: String,
+                  billable_metric_name: String,
+                  customer_id: String,
+                  end_timestamp: Time,
+                  start_timestamp: Time,
+                  value: T.nilable(Float),
+                  groups: T::Hash[Symbol, T.nilable(Float)]
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/usage_list_with_groups_params.rbi

@@ -0,0 +1,167 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class UsageListWithGroupsParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        sig { returns(String) }
+        attr_accessor :billable_metric_id
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        # A window_size of "day" or "hour" will return the usage for the specified period
+        # segmented into daily or hourly aggregates. A window_size of "none" will return a
+        # single usage aggregate for the entirety of the specified period.
+        sig { returns(MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize::OrSymbol) }
+        attr_accessor :window_size
+
+        # Max number of results that should be returned
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # Cursor that indicates where the next page of results should start.
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_page
+
+        sig { params(next_page: String).void }
+        attr_writer :next_page
+
+        # If true, will return the usage for the current billing period. Will return an
+        # error if the customer is currently uncontracted or starting_on and ending_before
+        # are specified when this is true.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :current_period
+
+        sig { params(current_period: T::Boolean).void }
+        attr_writer :current_period
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :ending_before
+
+        sig { params(ending_before: Time).void }
+        attr_writer :ending_before
+
+        sig { returns(T.nilable(MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy)) }
+        attr_reader :group_by
+
+        sig do
+          params(
+            group_by: T.any(MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy, MetronomeSDK::Internal::AnyHash)
+          )
+            .void
+        end
+        attr_writer :group_by
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :starting_on
+
+        sig { params(starting_on: Time).void }
+        attr_writer :starting_on
+
+        sig do
+          params(
+            billable_metric_id: String,
+            customer_id: String,
+            window_size: MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize::OrSymbol,
+            limit: Integer,
+            next_page: String,
+            current_period: T::Boolean,
+            ending_before: Time,
+            group_by: T.any(MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy, MetronomeSDK::Internal::AnyHash),
+            starting_on: Time,
+            request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          billable_metric_id:,
+          customer_id:,
+          # A window_size of "day" or "hour" will return the usage for the specified period
+          # segmented into daily or hourly aggregates. A window_size of "none" will return a
+          # single usage aggregate for the entirety of the specified period.
+          window_size:,
+          # Max number of results that should be returned
+          limit: nil,
+          # Cursor that indicates where the next page of results should start.
+          next_page: nil,
+          # If true, will return the usage for the current billing period. Will return an
+          # error if the customer is currently uncontracted or starting_on and ending_before
+          # are specified when this is true.
+          current_period: nil,
+          ending_before: nil,
+          group_by: nil,
+          starting_on: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                billable_metric_id: String,
+                customer_id: String,
+                window_size: MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize::OrSymbol,
+                limit: Integer,
+                next_page: String,
+                current_period: T::Boolean,
+                ending_before: Time,
+                group_by: MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy,
+                starting_on: Time,
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        # A window_size of "day" or "hour" will return the usage for the specified period
+        # segmented into daily or hourly aggregates. A window_size of "none" will return a
+        # single usage aggregate for the entirety of the specified period.
+        module WindowSize
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HOUR = T.let(:HOUR, MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize::TaggedSymbol)
+          DAY = T.let(:DAY, MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize::TaggedSymbol)
+          NONE = T.let(:NONE, MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize::TaggedSymbol)
+
+          sig { override.returns(T::Array[MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize::TaggedSymbol]) }
+          def self.values; end
+        end
+
+        class GroupBy < MetronomeSDK::Internal::Type::BaseModel
+          # The name of the group_by key to use
+          sig { returns(String) }
+          attr_accessor :key
+
+          # Values of the group_by key to return in the query. Omit this if you'd like all
+          # values for the key returned.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :values
+
+          sig { params(values: T::Array[String]).void }
+          attr_writer :values
+
+          sig { params(key: String, values: T::Array[String]).returns(T.attached_class) }
+          def self.new(
+            # The name of the group_by key to use
+            key:,
+            # Values of the group_by key to return in the query. Omit this if you'd like all
+            # values for the key returned.
+            values: nil
+          ); end
+          sig { override.returns({key: String, values: T::Array[String]}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/usage_list_with_groups_response.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class UsageListWithGroupsResponse < MetronomeSDK::Internal::Type::BaseModel
+        sig { returns(Time) }
+        attr_accessor :ending_before
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :group_key
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :group_value
+
+        sig { returns(Time) }
+        attr_accessor :starting_on
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :value
+
+        sig do
+          params(
+            ending_before: Time,
+            group_key: T.nilable(String),
+            group_value: T.nilable(String),
+            starting_on: Time,
+            value: T.nilable(Float)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(ending_before:, group_key:, group_value:, starting_on:, value:); end
+
+        sig do
+          override
+            .returns(
+              {
+                ending_before: Time,
+                group_key: T.nilable(String),
+                group_value: T.nilable(String),
+                starting_on: Time,
+                value: T.nilable(Float)
+              }
+            )
+        end
+        def to_hash; end
+      end
+    end
+  end
+end