Class: Orb::Models::PriceEditedWebhookEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::PriceEditedWebhookEvent

Defined in:

lib/orb/models/price_edited_webhook_event.rb,
sig/orb/models/price_edited_webhook_event.rbs

Defined Under Namespace

Modules: Type Classes: Properties

Instance Attribute Summary

• #created_at ⇒ Time

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

• #id ⇒ String

  The ID of this webhook event.

• #price ⇒ Orb::Models::Price::Unit, ...

  The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item.

• #properties ⇒ Orb::Models::PriceEditedWebhookEvent::Properties
• #type ⇒ Symbol, Orb::Models::PriceEditedWebhookEvent::Type

  The event this payload describes.

Instance Method Summary

• #initialize(metadata: nil) ⇒ Object constructor

  metadata values are non-null on the wire (deleting a key removes it from storage); the Optional values only exist on the new half of a metadata FieldChange.

• #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(metadata: nil) ⇒ Object

metadata values are non-null on the wire (deleting a key removes it from storage); the Optional values only exist on the new half of a metadata FieldChange.

Parameters:

• metadata (Hash{Symbol=>String}, nil) (defaults to: nil)

# File 'lib/orb/models/price_edited_webhook_event.rb', line 44

Instance Attribute Details

#created_at ⇒ Time

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

Parameters:

• value (Time)

Returns:

• (Time)

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

required :created_at, Time

#id ⇒ String

The ID of this webhook event.

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#price ⇒ Orb::Models::Price::Unit, ...

The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.

Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.

For more on the types of prices, see the core concepts documentation

Parameters:

• value (Orb::Models::price)

Returns:

• (Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput)

# File 'lib/orb/models/price_edited_webhook_event.rb', line 31

required :price, union: -> { Orb::Price }

#properties ⇒ Orb::Models::PriceEditedWebhookEvent::Properties

Parameters:

• value (Orb::PriceEditedWebhookEvent::Properties)

Returns:

• (Orb::Models::PriceEditedWebhookEvent::Properties)

# File 'lib/orb/models/price_edited_webhook_event.rb', line 36

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

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

The event this payload describes.

Parameters:

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

Returns:

• (Symbol, Orb::Models::PriceEditedWebhookEvent::Type)

# File 'lib/orb/models/price_edited_webhook_event.rb', line 42

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {