Class: Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/subscription_usage_exceeded_webhook_event.rb,
sig/orb/models/subscription_usage_exceeded_webhook_event.rbs

Overview

See Also:

  • Orb::Models::SubscriptionUsageExceededWebhookEvent#properties

Defined Under Namespace

Classes: AlertConfiguration

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(alert_configuration:, billable_metric_id:, evaluated_quantity:, quantity_threshold:, timeframe_end:, timeframe_start:) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties for more details.

Parameters:




# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 108

Instance Attribute Details

#alert_configuration ⇒ Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration

Alerts within Orb monitor spending, usage, or credit balance and trigger webhooks when a threshold is exceeded.

Alerts created through the API can be scoped to either customers or subscriptions.

Parameters:

  • value (Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration)

Returns:



80
81
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 80

required :alert_configuration,
-> { Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration }

#billable_metric_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


86
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 86

required :billable_metric_id, String

#evaluated_quantity ⇒ Float?

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


91
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 91

required :evaluated_quantity, Float, nil?: true

#quantity_threshold ⇒ Float?

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


96
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 96

required :quantity_threshold, Float, nil?: true

#timeframe_end ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


101
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 101

required :timeframe_end, Time

#timeframe_start ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


106
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 106

required :timeframe_start, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


71
 
# File 'sig/orb/models/subscription_usage_exceeded_webhook_event.rbs', line 71

def to_hash: -> {