Class: MetronomeSDK::Models::V1::UsageListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/metronome_sdk/models/v1/usage_list_params.rb

Overview

See Also:

• Resources::V1::Usage#list

Defined Under Namespace

Modules: WindowSize Classes: BillableMetric

Instance Attribute Summary

• #billable_metrics ⇒ Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>^?

  A list of billable metrics to fetch usage for.

• #customer_ids ⇒ Array<String>^?

  A list of Metronome customer IDs to fetch usage for.

• #ending_before ⇒ Time
• #next_page ⇒ String^?

  Cursor that indicates where the next page of results should start.

• #starting_on ⇒ Time
• #window_size ⇒ Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize

  A window_size of “day” or “hour” will return the usage for the specified period segmented into daily or hourly aggregates.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(ending_before: , starting_on: , window_size: , next_page: nil, billable_metrics: nil, customer_ids: nil, request_options: {}) ⇒ Object constructor

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

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(ending_before: , starting_on: , window_size: , next_page: nil, billable_metrics: nil, customer_ids: nil, request_options: {}) ⇒ Object

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

Parameters:

• ending_before (Time) (defaults to: )
• starting_on (Time) (defaults to: )
• window_size (Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize) (defaults to: ) —

  A window_size of “day” or “hour” will return the usage for the specified period

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

  Cursor that indicates where the next page of results should start.

• billable_metrics (Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>) (defaults to: nil) —

  A list of billable metrics to fetch usage for. If absent, all billable metrics w

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

  A list of Metronome customer IDs to fetch usage for. If absent, usage for all cu

• request_options (MetronomeSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#billable_metrics ⇒ Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>^?

A list of billable metrics to fetch usage for. If absent, all billable metrics will be returned.

Returns:

• (Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>, nil)

# File 'lib/metronome_sdk/models/v1/usage_list_params.rb', line 40

optional :billable_metrics,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageListParams::BillableMetric] }

#customer_ids ⇒ Array<String>^?

A list of Metronome customer IDs to fetch usage for. If absent, usage for all customers will be returned.

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/usage_list_params.rb', line 48

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

#ending_before ⇒ Time

Returns:

• (Time)

# File 'lib/metronome_sdk/models/v1/usage_list_params.rb', line 14

required :ending_before, Time

#next_page ⇒ String^?

Cursor that indicates where the next page of results should start.

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/usage_list_params.rb', line 33

optional :next_page, String

#starting_on ⇒ Time

Returns:

• (Time)

# File 'lib/metronome_sdk/models/v1/usage_list_params.rb', line 19

required :starting_on, Time

#window_size ⇒ Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize

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.

Returns:

• (Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize)

# File 'lib/metronome_sdk/models/v1/usage_list_params.rb', line 27

required :window_size, enum: -> { MetronomeSDK::V1::UsageListParams::WindowSize }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/usage_list_params.rb', line 78