Class: MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Modules: AggregationType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#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) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data for more details.

Parameters:

  • id (String) (defaults to: ) —

    ID of the billable metric

  • name (String) (defaults to: ) —

    The display name of the billable metric.

  • aggregation_key (String) (defaults to: nil) —

    A key that specifies which property of the event is used to aggregate data. This

  • aggregation_type (Symbol, MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::AggregationType) (defaults to: nil) —

    Specifies the type of aggregation performed on matching events.

  • archived_at (Time) (defaults to: nil) —

    RFC 3339 timestamp indicating when the billable metric was archived. If not prov

  • custom_fields (Hash{Symbol=>String}) (defaults to: nil) —

    Custom fields to be added eg. { “key1”: “value1”, “key2”: “value2” }

  • event_type_filter (MetronomeSDK::Models::EventTypeFilter) (defaults to: nil) —

    An optional filtering rule to match the ‘event_type’ property of an event.

  • group_keys (Array<Array<String>>) (defaults to: nil) —

    Property names that are used to group usage costs on an invoice. Each entry repr

  • property_filters (Array<MetronomeSDK::Models::PropertyFilter>) (defaults to: nil) —

    A list of filters to match events to this billable metric. Each filter defines a

  • sql (String) (defaults to: nil) —

    The SQL query associated with the billable metric




# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 85

Instance Attribute Details

#aggregation_key ⇒ String?

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’.

Returns:

  • (String, nil) 


36
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 36

optional :aggregation_key, String

#aggregation_type ⇒ Symbol, ...

Specifies the type of aggregation performed on matching events.

Returns:



42
43
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 42

optional :aggregation_type,
enum: -> { MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::AggregationType }

#archived_at ⇒ Time?

RFC 3339 timestamp indicating when the billable metric was archived. If not provided, the billable metric is not archived.

Returns:

  • (Time, nil) 


50
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 50

optional :archived_at, Time

#custom_fields ⇒ Hash{Symbol=>String}?

Custom fields to be added eg. { “key1”: “value1”, “key2”: “value2” }

Returns:

  • (Hash{Symbol=>String}, nil) 


56
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 56

optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#event_type_filter ⇒ MetronomeSDK::Models::EventTypeFilter?

An optional filtering rule to match the ‘event_type’ property of an event.

Returns:



62
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 62

optional :event_type_filter, -> { MetronomeSDK::EventTypeFilter }

#group_keys ⇒ Array<Array<String>>?

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.

Returns:

  • (Array<Array<String>>, nil) 


69
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 69

optional :group_keys, MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Internal::Type::ArrayOf[String]]

#id ⇒ String

ID of the billable metric

Returns:

  • (String) 


22
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 22

required :id, String

#name ⇒ String

The display name of the billable metric.

Returns:

  • (String) 


28
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 28

required :name, String

#property_filters ⇒ Array<MetronomeSDK::Models::PropertyFilter>?

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.

Returns:



77
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 77

optional :property_filters, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::PropertyFilter] }

#sql ⇒ String?

The SQL query associated with the billable metric

Returns:

  • (String, nil) 


83
 
# File 'lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb', line 83

optional :sql, String