Class: MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse

Defined in:

lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb,
sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs

Overview

See Also:

• MetronomeSDK::Resources::V1::Customers#list_billable_metrics

Defined Under Namespace

Modules: AggregationType

Constant Summary

MetronomeSDK =

Returns:

• (:EventTypeFilter)

Instance Attribute Summary

• #aggregate ⇒ String^?

  (DEPRECATED) use aggregation_type instead.

• #aggregate_keys ⇒ Array<String>^?

  (DEPRECATED) use aggregation_key instead.

• #aggregation_key ⇒ String^?

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

• #aggregation_type ⇒ Symbol, ...

  Specifies the type of aggregation performed on matching events.

• #archived_at ⇒ Time^?

  RFC 3339 timestamp indicating when the billable metric was archived.

• #custom_fields ⇒ Hash{Symbol=>String}^?

  Custom fields to be added eg.

• #event_type_filter ⇒ MetronomeSDK::Models::EventTypeFilter^?

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

• #filter ⇒ Hash{Symbol=>Object}^?

  (DEPRECATED) use property_filters & event_type_filter instead.

• #group_by ⇒ Array<String>^?

  (DEPRECATED) use group_keys instead.

• #group_keys ⇒ Array<Array<String>>^?

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

• #id ⇒ String
• #name ⇒ String
• #property_filters ⇒ Array<MetronomeSDK::Models::PropertyFilter>^?

  A list of filters to match events to this billable metric.

• #sql ⇒ String^?

  The SQL query associated with the billable metric.

Instance Method Summary

• #initialize(id:, name:, aggregate: nil, aggregate_keys: nil, aggregation_key: nil, aggregation_type: nil, archived_at: nil, custom_fields: nil, event_type_filter: nil, filter: nil, group_by: nil, group_keys: nil, property_filters: nil, sql: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see CustomerListBillableMetricsResponse for more details.

• #to_hash ⇒ {

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:, aggregate: nil, aggregate_keys: nil, aggregation_key: nil, aggregation_type: nil, archived_at: nil, custom_fields: nil, event_type_filter: nil, filter: nil, group_by: nil, group_keys: nil, property_filters: nil, sql: nil) ⇒ Object

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

Parameters:

• id (String)
• name (String)
• aggregate (String) (defaults to: nil) —

  (DEPRECATED) use aggregation_type instead

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

  (DEPRECATED) use aggregation_key instead

• 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::CustomerListBillableMetricsResponse::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.

• filter (Hash{Symbol=>Object}) (defaults to: nil) —

  (DEPRECATED) use property_filters & event_type_filter instead

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

  (DEPRECATED) use group_keys instead

• 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/customer_list_billable_metrics_response.rb', line 97

Instance Attribute Details

#aggregate ⇒ String^?

(DEPRECATED) use aggregation_type instead

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :aggregate, String

#aggregate_keys ⇒ Array<String>^?

(DEPRECATED) use aggregation_key instead

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

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

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

#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'.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :aggregation_key, String

#aggregation_type ⇒ Symbol, ...

Specifies the type of aggregation performed on matching events.

Returns:

• (Symbol, MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::AggregationType, nil)

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

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

#archived_at ⇒ Time^?

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

Parameters:

• (Time)

Returns:

• (Time, nil)

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

optional :archived_at, Time

#custom_fields ⇒ Hash{Symbol=>String}^?

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

Parameters:

• (::Hash[Symbol, String])

Returns:

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

# File 'lib/metronome_sdk/models/v1/customer_list_billable_metrics_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:

• (MetronomeSDK::Models::EventTypeFilter, nil)

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

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

#filter ⇒ Hash{Symbol=>Object}^?

(DEPRECATED) use property_filters & event_type_filter instead

Parameters:

• (::Hash[Symbol, top])

Returns:

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

# File 'lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb', line 68

optional :filter, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]

#group_by ⇒ Array<String>^?

(DEPRECATED) use group_keys instead

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb', line 74

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

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

Parameters:

• (::Array[::Array[String]])

Returns:

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

# File 'lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb', line 81

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

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb', line 11

required :id, String

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb', line 16

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:

• (Array<MetronomeSDK::Models::PropertyFilter>, nil)

# File 'lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb', line 89

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

#sql ⇒ String^?

The SQL query associated with the billable metric

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb', line 95

optional :sql, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs', line 98

def to_hash: -> {