metronome-sdk 0.1.0.pre.alpha.1

data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::BillableMetrics#archive
+      class BillableMetricArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::ID]
+        required :data, -> { MetronomeSDK::Models::ID }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::ID]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::BillableMetrics#create
+      class BillableMetricCreateParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute name
+        #   The display name of the billable metric.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute aggregation_key
+        #   Specifies the type of aggregation performed on matching events. Required if
+        #   `sql` is not provided.
+        #
+        #   @return [String, nil]
+        optional :aggregation_key, String
+
+        # @!attribute aggregation_type
+        #   Specifies the type of aggregation performed on matching events.
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType, nil]
+        optional :aggregation_type,
+                 enum: -> { MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType }
+
+        # @!attribute custom_fields
+        #   Custom fields to attach to the billable metric.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!attribute event_type_filter
+        #   An optional filtering rule to match the 'event_type' property of an event.
+        #
+        #   @return [MetronomeSDK::Models::EventTypeFilter, nil]
+        optional :event_type_filter, -> { MetronomeSDK::Models::EventTypeFilter }
+
+        # @!attribute group_keys
+        #   Property names that are used to group usage costs on an invoice. Each entry
+        #   represents a set of properties used to slice events into distinct buckets.
+        #
+        #   @return [Array<Array<String>>, nil]
+        optional :group_keys,
+                 MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Internal::Type::ArrayOf[String]]
+
+        # @!attribute property_filters
+        #   A list of filters to match events to this billable metric. Each filter defines a
+        #   rule on an event property. All rules must pass for the event to match the
+        #   billable metric.
+        #
+        #   @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
+        optional :property_filters,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::PropertyFilter] }
+
+        # @!attribute sql
+        #   The SQL query associated with the billable metric. This field is mutually
+        #   exclusive with aggregation_type, event_type_filter, property_filters,
+        #   aggregation_key, and group_keys. If provided, these other fields must be
+        #   omitted.
+        #
+        #   @return [String, nil]
+        optional :sql, String
+
+        # @!method initialize(name:, aggregation_key: nil, aggregation_type: nil, custom_fields: nil, event_type_filter: nil, group_keys: nil, property_filters: nil, sql: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::BillableMetricCreateParams} for more details.
+        #
+        #   @param name [String] The display name of the billable metric.
+        #
+        #   @param aggregation_key [String] Specifies the type of aggregation performed on matching events. Required if `sql
+        #   ...
+        #
+        #   @param aggregation_type [Symbol, MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType] Specifies the type of aggregation performed on matching events.
+        #
+        #   @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the billable metric.
+        #
+        #   @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
+        #
+        #   @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
+        #   ...
+        #
+        #   @param property_filters [Array<MetronomeSDK::Models::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
+        #   ...
+        #
+        #   @param sql [String] The SQL query associated with the billable metric. This field is mutually exclus
+        #   ...
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        # Specifies the type of aggregation performed on matching events.
+        module AggregationType
+          extend MetronomeSDK::Internal::Type::Enum
+
+          COUNT = :COUNT
+          LATEST = :LATEST
+          MAX = :MAX
+          SUM = :SUM
+          UNIQUE = :UNIQUE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::BillableMetrics#create
+      class BillableMetricCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::ID]
+        required :data, -> { MetronomeSDK::Models::ID }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::ID]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/billable_metric_list_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::BillableMetrics#list
+      class BillableMetricListParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute include_archived
+        #   If true, the list of returned metrics will include archived metrics
+        #
+        #   @return [Boolean, nil]
+        optional :include_archived, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute limit
+        #   Max number of results that should be returned
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute next_page
+        #   Cursor that indicates where the next page of results should start.
+        #
+        #   @return [String, nil]
+        optional :next_page, String
+
+        # @!method initialize(include_archived: nil, limit: nil, next_page: nil, request_options: {})
+        #   @param include_archived [Boolean] If true, the list of returned metrics will include archived metrics
+        #
+        #   @param limit [Integer] Max number of results that should be returned
+        #
+        #   @param next_page [String] Cursor that indicates where the next page of results should start.
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::BillableMetrics#list
+      class BillableMetricListResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   ID of the billable metric
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The display name of the billable metric.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute aggregation_key
+        #   A key that specifies which property of the event is used to aggregate data. This
+        #   key must be one of the property filter names and is not applicable when the
+        #   aggregation type is 'count'.
+        #
+        #   @return [String, nil]
+        optional :aggregation_key, String
+
+        # @!attribute aggregation_type
+        #   Specifies the type of aggregation performed on matching events.
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::BillableMetricListResponse::AggregationType, nil]
+        optional :aggregation_type,
+                 enum: -> { MetronomeSDK::Models::V1::BillableMetricListResponse::AggregationType }
+
+        # @!attribute archived_at
+        #   RFC 3339 timestamp indicating when the billable metric was archived. If not
+        #   provided, the billable metric is not archived.
+        #
+        #   @return [Time, nil]
+        optional :archived_at, Time
+
+        # @!attribute custom_fields
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!attribute event_type_filter
+        #   An optional filtering rule to match the 'event_type' property of an event.
+        #
+        #   @return [MetronomeSDK::Models::EventTypeFilter, nil]
+        optional :event_type_filter, -> { MetronomeSDK::Models::EventTypeFilter }
+
+        # @!attribute group_keys
+        #   Property names that are used to group usage costs on an invoice. Each entry
+        #   represents a set of properties used to slice events into distinct buckets.
+        #
+        #   @return [Array<Array<String>>, nil]
+        optional :group_keys,
+                 MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Internal::Type::ArrayOf[String]]
+
+        # @!attribute property_filters
+        #   A list of filters to match events to this billable metric. Each filter defines a
+        #   rule on an event property. All rules must pass for the event to match the
+        #   billable metric.
+        #
+        #   @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
+        optional :property_filters,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::PropertyFilter] }
+
+        # @!attribute sql
+        #   The SQL query associated with the billable metric
+        #
+        #   @return [String, nil]
+        optional :sql, String
+
+        # @!method initialize(id:, name:, aggregation_key: nil, aggregation_type: nil, archived_at: nil, custom_fields: nil, event_type_filter: nil, group_keys: nil, property_filters: nil, sql: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::BillableMetricListResponse} for more details.
+        #
+        #   @param id [String] ID of the billable metric
+        #
+        #   @param name [String] The display name of the billable metric.
+        #
+        #   @param aggregation_key [String] A key that specifies which property of the event is used to aggregate data. This
+        #   ...
+        #
+        #   @param aggregation_type [Symbol, MetronomeSDK::Models::V1::BillableMetricListResponse::AggregationType] Specifies the type of aggregation performed on matching events.
+        #
+        #   @param archived_at [Time] RFC 3339 timestamp indicating when the billable metric was archived. If not prov
+        #   ...
+        #
+        #   @param custom_fields [Hash{Symbol=>String}]
+        #
+        #   @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
+        #
+        #   @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
+        #   ...
+        #
+        #   @param property_filters [Array<MetronomeSDK::Models::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
+        #   ...
+        #
+        #   @param sql [String] The SQL query associated with the billable metric
+
+        # Specifies the type of aggregation performed on matching events.
+        #
+        # @see MetronomeSDK::Models::V1::BillableMetricListResponse#aggregation_type
+        module AggregationType
+          extend MetronomeSDK::Internal::Type::Enum
+
+          COUNT = :COUNT
+          LATEST = :LATEST
+          MAX = :MAX
+          SUM = :SUM
+          UNIQUE = :UNIQUE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/billable_metric_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::BillableMetrics#retrieve
+      class BillableMetricRetrieveParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute billable_metric_id
+        #
+        #   @return [String]
+        required :billable_metric_id, String
+
+        # @!method initialize(billable_metric_id:, request_options: {})
+        #   @param billable_metric_id [String]
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::BillableMetrics#retrieve
+      class BillableMetricRetrieveResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::BillableMetricRetrieveResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   ID of the billable metric
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute name
+          #   The display name of the billable metric.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute aggregation_key
+          #   A key that specifies which property of the event is used to aggregate data. This
+          #   key must be one of the property filter names and is not applicable when the
+          #   aggregation type is 'count'.
+          #
+          #   @return [String, nil]
+          optional :aggregation_key, String
+
+          # @!attribute aggregation_type
+          #   Specifies the type of aggregation performed on matching events.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::AggregationType, nil]
+          optional :aggregation_type,
+                   enum: -> { MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::AggregationType }
+
+          # @!attribute archived_at
+          #   RFC 3339 timestamp indicating when the billable metric was archived. If not
+          #   provided, the billable metric is not archived.
+          #
+          #   @return [Time, nil]
+          optional :archived_at, Time
+
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+          # @!attribute event_type_filter
+          #   An optional filtering rule to match the 'event_type' property of an event.
+          #
+          #   @return [MetronomeSDK::Models::EventTypeFilter, nil]
+          optional :event_type_filter, -> { MetronomeSDK::Models::EventTypeFilter }
+
+          # @!attribute group_keys
+          #   Property names that are used to group usage costs on an invoice. Each entry
+          #   represents a set of properties used to slice events into distinct buckets.
+          #
+          #   @return [Array<Array<String>>, nil]
+          optional :group_keys,
+                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Internal::Type::ArrayOf[String]]
+
+          # @!attribute property_filters
+          #   A list of filters to match events to this billable metric. Each filter defines a
+          #   rule on an event property. All rules must pass for the event to match the
+          #   billable metric.
+          #
+          #   @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
+          optional :property_filters,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::PropertyFilter] }
+
+          # @!attribute sql
+          #   The SQL query associated with the billable metric
+          #
+          #   @return [String, nil]
+          optional :sql, String
+
+          # @!method initialize(id:, name:, aggregation_key: nil, aggregation_type: nil, archived_at: nil, custom_fields: nil, event_type_filter: nil, group_keys: nil, property_filters: nil, sql: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data} for more
+          #   details.
+          #
+          #   @param id [String] ID of the billable metric
+          #
+          #   @param name [String] The display name of the billable metric.
+          #
+          #   @param aggregation_key [String] A key that specifies which property of the event is used to aggregate data. This
+          #   ...
+          #
+          #   @param aggregation_type [Symbol, MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::AggregationType] Specifies the type of aggregation performed on matching events.
+          #
+          #   @param archived_at [Time] RFC 3339 timestamp indicating when the billable metric was archived. If not prov
+          #   ...
+          #
+          #   @param custom_fields [Hash{Symbol=>String}]
+          #
+          #   @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
+          #
+          #   @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
+          #   ...
+          #
+          #   @param property_filters [Array<MetronomeSDK::Models::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
+          #   ...
+          #
+          #   @param sql [String] The SQL query associated with the billable metric
+
+          # Specifies the type of aggregation performed on matching events.
+          #
+          # @see MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data#aggregation_type
+          module AggregationType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            COUNT = :COUNT
+            LATEST = :LATEST
+            MAX = :MAX
+            SUM = :SUM
+            UNIQUE = :UNIQUE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Contracts#add_manual_balance_entry
+      class ContractAddManualBalanceEntryParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #   ID of the balance (commit or credit) to update.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #   Amount to add to the segment. A negative number will draw down from the balance.
+        #
+        #   @return [Float]
+        required :amount, Float
+
+        # @!attribute customer_id
+        #   ID of the customer whose balance is to be updated.
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute reason
+        #   Reason for the manual adjustment. This will be displayed in the ledger.
+        #
+        #   @return [String]
+        required :reason, String
+
+        # @!attribute segment_id
+        #   ID of the segment to update.
+        #
+        #   @return [String]
+        required :segment_id, String
+
+        # @!attribute contract_id
+        #   ID of the contract to update. Leave blank to update a customer level balance.
+        #
+        #   @return [String, nil]
+        optional :contract_id, String
+
+        # @!attribute timestamp
+        #   RFC 3339 timestamp indicating when the manual adjustment takes place. If not
+        #   provided, it will default to the start of the segment.
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!method initialize(id:, amount:, customer_id:, reason:, segment_id:, contract_id: nil, timestamp: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::ContractAddManualBalanceEntryParams} for more
+        #   details.
+        #
+        #   @param id [String] ID of the balance (commit or credit) to update.
+        #
+        #   @param amount [Float] Amount to add to the segment. A negative number will draw down from the balance.
+        #   ...
+        #
+        #   @param customer_id [String] ID of the customer whose balance is to be updated.
+        #
+        #   @param reason [String] Reason for the manual adjustment. This will be displayed in the ledger.
+        #
+        #   @param segment_id [String] ID of the segment to update.
+        #
+        #   @param contract_id [String] ID of the contract to update. Leave blank to update a customer level balance.
+        #
+        #   @param timestamp [Time] RFC 3339 timestamp indicating when the manual adjustment takes place. If not pro
+        #   ...
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end