Class: Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent

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

Defined Under Namespace

Modules: Type Classes: Properties, Subscription

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(allocation_amount:, license_type_id:, pricing_unit_id:) ⇒ Object

A license allocation replenished at the start of a billing period.

Parameters:

  • allocation_amount (String)
  • license_type_id (String)
  • pricing_unit_id (String) 



# File 'lib/orb/models/subscription_license_allocation_reset_webhook_event.rb', line 40

Instance Attribute Details

#created_at ⇒ Time

The time at which this event was created, to the second.

Parameters:

  • value (Time)

Returns:

  • (Time) 


16
 
# File 'lib/orb/models/subscription_license_allocation_reset_webhook_event.rb', line 16

required :created_at, Time

#id ⇒ String

The ID of this webhook event.

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/orb/models/subscription_license_allocation_reset_webhook_event.rb', line 10

required :id, String

#properties ⇒ Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent::Properties

Fires at the start of a billing period when license allocations are replenished. Allocations sharing a billing period are batched into one message.

Parameters:

  • value (Orb::SubscriptionLicenseAllocationResetWebhookEvent::Properties)

Returns:



23
 
# File 'lib/orb/models/subscription_license_allocation_reset_webhook_event.rb', line 23

required :properties, -> { Orb::SubscriptionLicenseAllocationResetWebhookEvent::Properties }

#subscription ⇒ Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent::Subscription

A lightweight subscription representation for webhook payloads.

This avoids the expensive to_subscription_params() call required for full serialization.

Parameters:

  • value (Orb::SubscriptionLicenseAllocationResetWebhookEvent::Subscription)

Returns:



32
 
# File 'lib/orb/models/subscription_license_allocation_reset_webhook_event.rb', line 32

required :subscription, -> { Orb::SubscriptionLicenseAllocationResetWebhookEvent::Subscription }

#type ⇒ Symbol, Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent::Type

The event this payload describes.

Parameters:

  • value (Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent::type_)

Returns:



38
 
# File 'lib/orb/models/subscription_license_allocation_reset_webhook_event.rb', line 38

required :type, enum: -> { Orb::SubscriptionLicenseAllocationResetWebhookEvent::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/subscription_license_allocation_reset_webhook_event.rb', line 196

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


31
 
# File 'sig/orb/models/subscription_license_allocation_reset_webhook_event.rbs', line 31

def to_hash: -> {