Class: Orb::Models::UsageDiscount

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/usage_discount.rb

Defined Under Namespace

Modules: DiscountType

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(discount_type: , usage_discount: , applies_to_price_ids: nil, filters: nil, reason: nil) ⇒ Object

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

Parameters:

  • discount_type (Symbol, Orb::Models::UsageDiscount::DiscountType) (defaults to: )
  • usage_discount (Float) (defaults to: ) —

    Only available if discount_type is ‘usage`. Number of usage units that this disc

  • applies_to_price_ids (Array<String>, nil) (defaults to: nil) —

    List of price_ids that this discount applies to. For plan/plan phase discounts,

  • filters (Array<Orb::Models::TransformPriceFilter>, nil) (defaults to: nil) —

    The filters that determine which prices to apply this discount to.

  • reason (String, nil) (defaults to: nil) 



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

Instance Attribute Details

#applies_to_price_ids ⇒ Array<String>?

List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.

Returns:

  • (Array<String>, nil) 


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

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

#discount_type ⇒ Symbol, Orb::Models::UsageDiscount::DiscountType

Returns:



9
 
# File 'lib/orb/models/usage_discount.rb', line 9

required :discount_type, enum: -> { Orb::UsageDiscount::DiscountType }

#filters ⇒ Array<Orb::Models::TransformPriceFilter>?

The filters that determine which prices to apply this discount to.

Returns:



29
 
# File 'lib/orb/models/usage_discount.rb', line 29

optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }, nil?: true

#reason ⇒ String?

Returns:

  • (String, nil) 


34
 
# File 'lib/orb/models/usage_discount.rb', line 34

optional :reason, String, nil?: true

#usage_discount ⇒ Float

Only available if discount_type is ‘usage`. Number of usage units that this discount is for

Returns:

  • (Float) 


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

required :usage_discount, Float