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

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

Defined Under Namespace

Modules: Type Classes: BalanceAlertStatus, LicenseType, Metric, Plan, PriceFilter, Threshold, ThresholdOverride

Instance Attribute Summary collapse

Class Method 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:) ⇒ Object

Minified license type for alert serialization.

Parameters:

  • id (String) 



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

Instance Attribute Details

#balance_alert_status ⇒ Array<Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus>?

The current status of the alert. This field is only present for credit balance alerts.

Parameters:

  • value (::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus], nil)

Returns:



202
203
204
205
206
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 202

optional :balance_alert_status,
-> {
  Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus]
},
nil?: true

#created_at ⇒ Time

The creation time of the resource in Orb.

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :created_at, Time

#currency ⇒ String?

The name of the currency the credit balance or invoice cost is denominated in.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :currency, String, nil?: true

#customer ⇒ Orb::Models::CustomerMinified?

The customer the alert applies to.

Parameters:

Returns:



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

required :customer, -> { Orb::CustomerMinified }, nil?: true

#enabled ⇒ Boolean

Whether the alert is enabled or disabled.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

required :enabled, Orb::Internal::Type::Boolean

#grouping_keys ⇒ Array<String>?

The property keys to group cost alerts by. Only present for cost alerts with grouping enabled.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


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

optional :grouping_keys, Orb::Internal::Type::ArrayOf[String], nil?: true

#id ⇒ String

Also referred to as alert_id in this documentation.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#license_type ⇒ Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::LicenseType?

Minified license type for alert serialization.

Parameters:

  • value (Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::LicenseType, nil)

Returns:



219
220
221
222
223
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 219

optional :license_type,
-> {
  Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::LicenseType
},
nil?: true

#metric ⇒ Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Metric?

The metric the alert applies to.

Parameters:

  • value (Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Metric, nil)

Returns:



161
162
163
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 161

required :metric,
-> { Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Metric },
nil?: true

#plan ⇒ Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Plan?

The plan the alert applies to.

Parameters:

  • value (Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Plan, nil)

Returns:



169
170
171
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 169

required :plan,
-> { Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Plan },
nil?: true

#price_filters ⇒ Array<Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter>?

Filters scoping which prices are included in spend and grouped cost alert evaluation. Alerts use the price_id, item_id, and price_type fields only; the alert's pricing unit is reported by currency.

Parameters:

  • value (::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter], nil)

Returns:



231
232
233
234
235
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 231

optional :price_filters,
-> {
  Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::PriceFilter]
},
nil?: true

#subscription ⇒ Orb::Models::SubscriptionMinified?

The subscription the alert applies to.

Parameters:

Returns:



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

required :subscription, -> { Orb::SubscriptionMinified }, nil?: true

#threshold_overrides ⇒ Array<Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride>?

Per-group threshold overrides. Each override maps a specific combination of grouping_keys values to a replacement threshold list. Only present for grouped cost alerts that have at least one override.

Parameters:

  • value (::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride], nil)

Returns:



243
244
245
246
247
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 243

optional :threshold_overrides,
-> {
  Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::ThresholdOverride]
},
nil?: true

#thresholds ⇒ Array<Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Threshold>?

The thresholds that define the conditions under which the alert will be triggered.

Parameters:

  • value (::Array[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Threshold], nil)

Returns:



184
185
186
187
188
 
# File 'lib/orb/models/subscription_usage_exceeded_webhook_event.rb', line 184

required :thresholds,
-> {
  Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Threshold]
},
nil?: true

#type ⇒ Symbol, Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Type

The type of alert. This must be a valid alert type.

Parameters:

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

Returns:



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

required :type,
enum: -> { Orb::SubscriptionUsageExceededWebhookEvent::Properties::AlertConfiguration::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {