Class: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::EventOutput::EventOutputConfig

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::EventOutput::EventOutputConfig

Defined in:

lib/orb/models/beta/external_plan_id_create_plan_version_params.rb,
sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs

Overview

See Also:

• Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::EventOutput#event_output_config

Instance Attribute Summary

• #default_unit_rate ⇒ String^?

  If provided, this amount will be used as the unit rate when an event does not have a value for the unit_rating_key.

• #grouping_key ⇒ String^?

  An optional key in the event data to group by (e.g., event ID).

• #unit_rating_key ⇒ String

  The key in the event data to extract the unit rate from.

Instance Method Summary

• #initialize ⇒ Object constructor
• #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 ⇒ Object

# File 'sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs', line 2069

def initialize: (

Instance Attribute Details

#default_unit_rate ⇒ String^?

If provided, this amount will be used as the unit rate when an event does not have a value for the unit_rating_key. If not provided, events missing a unit rate will be ignored.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 2974

optional :default_unit_rate, String, nil?: true

#grouping_key ⇒ String^?

An optional key in the event data to group by (e.g., event ID). All events will also be grouped by their unit rate.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 2981

optional :grouping_key, String, nil?: true

#unit_rating_key ⇒ String

The key in the event data to extract the unit rate from.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 2966

required :unit_rating_key, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs', line 2075

def to_hash: -> {