Class: MetronomeSDK::Models::Override

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::Override

Defined in:

lib/metronome_sdk/models/override.rb,
sig/metronome_sdk/models/override.rbs

Defined Under Namespace

Modules: RateType, Target, Type Classes: OverrideSpecifier, Product

Constant Summary

MetronomeSDK =

Returns:

• (:CreditTypeData)

Instance Attribute Summary

• #applicable_product_tags ⇒ Array<String>^?
• #created_at ⇒ Time
• #credit_type ⇒ MetronomeSDK::Models::CreditTypeData^?
• #ending_before ⇒ Time^?
• #entitled ⇒ Boolean^?
• #id ⇒ String
• #is_commit_specific ⇒ Boolean^?
• #is_prorated ⇒ Boolean^?

  Default proration configuration.

• #multiplier ⇒ Float^?
• #override_specifiers ⇒ Array<MetronomeSDK::Models::Override::OverrideSpecifier>^?
• #override_tiers ⇒ Array<MetronomeSDK::Models::OverrideTier>^?
• #overwrite_rate ⇒ MetronomeSDK::Models::OverwriteRate^?
• #price ⇒ Float^?

  Default price.

• #priority ⇒ Float^?
• #product ⇒ MetronomeSDK::Models::Override::Product^?
• #quantity ⇒ Float^?

  Default quantity.

• #rate_type ⇒ Symbol, ...
• #starting_at ⇒ Time
• #target ⇒ Symbol, ...
• #tiers ⇒ Array<MetronomeSDK::Models::Tier>^?

  Only set for TIERED rate_type.

• #type ⇒ Symbol, ...
• #value ⇒ Hash{Symbol=>Object}^?

  Only set for CUSTOM rate_type.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, name:) ⇒ Object constructor
• #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(id:, name:) ⇒ Object

Parameters:

• id (String)
• name (String)

# File 'lib/metronome_sdk/models/override.rb', line 250

Instance Attribute Details

#applicable_product_tags ⇒ Array<String>^?

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/override.rb', line 24

optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/metronome_sdk/models/override.rb', line 14

required :created_at, Time

#credit_type ⇒ MetronomeSDK::Models::CreditTypeData^?

Returns:

• (MetronomeSDK::Models::CreditTypeData, nil)

# File 'lib/metronome_sdk/models/override.rb', line 29

optional :credit_type, -> { MetronomeSDK::CreditTypeData }

#ending_before ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/metronome_sdk/models/override.rb', line 34

optional :ending_before, Time

#entitled ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/metronome_sdk/models/override.rb', line 39

optional :entitled, MetronomeSDK::Internal::Type::Boolean

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/metronome_sdk/models/override.rb', line 9

required :id, String

#is_commit_specific ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/metronome_sdk/models/override.rb', line 44

optional :is_commit_specific, MetronomeSDK::Internal::Type::Boolean

#is_prorated ⇒ Boolean^?

Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/metronome_sdk/models/override.rb', line 51

optional :is_prorated, MetronomeSDK::Internal::Type::Boolean

#multiplier ⇒ Float^?

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/override.rb', line 56

optional :multiplier, Float

#override_specifiers ⇒ Array<MetronomeSDK::Models::Override::OverrideSpecifier>^?

Returns:

• (Array<MetronomeSDK::Models::Override::OverrideSpecifier>, nil)

# File 'lib/metronome_sdk/models/override.rb', line 61

optional :override_specifiers,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override::OverrideSpecifier] }

#override_tiers ⇒ Array<MetronomeSDK::Models::OverrideTier>^?

Returns:

• (Array<MetronomeSDK::Models::OverrideTier>, nil)

# File 'lib/metronome_sdk/models/override.rb', line 67

optional :override_tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::OverrideTier] }

#overwrite_rate ⇒ MetronomeSDK::Models::OverwriteRate^?

Returns:

• (MetronomeSDK::Models::OverwriteRate, nil)

# File 'lib/metronome_sdk/models/override.rb', line 72

optional :overwrite_rate, -> { MetronomeSDK::OverwriteRate }

#price ⇒ Float^?

Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/override.rb', line 79

optional :price, Float

#priority ⇒ Float^?

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/override.rb', line 84

optional :priority, Float

#product ⇒ MetronomeSDK::Models::Override::Product^?

Returns:

• (MetronomeSDK::Models::Override::Product, nil)

# File 'lib/metronome_sdk/models/override.rb', line 89

optional :product, -> { MetronomeSDK::Override::Product }

#quantity ⇒ Float^?

Default quantity. For SUBSCRIPTION rate_type, this must be >=0.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/override.rb', line 95

optional :quantity, Float

#rate_type ⇒ Symbol, ...

Returns:

• (Symbol, MetronomeSDK::Models::Override::RateType, nil)

# File 'lib/metronome_sdk/models/override.rb', line 100

optional :rate_type, enum: -> { MetronomeSDK::Override::RateType }

#starting_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/metronome_sdk/models/override.rb', line 19

required :starting_at, Time

#target ⇒ Symbol, ...

Returns:

• (Symbol, MetronomeSDK::Models::Override::Target, nil)

# File 'lib/metronome_sdk/models/override.rb', line 105

optional :target, enum: -> { MetronomeSDK::Override::Target }

#tiers ⇒ Array<MetronomeSDK::Models::Tier>^?

Only set for TIERED rate_type.

Parameters:

• (::Array[MetronomeSDK::Tier])

Returns:

• (Array<MetronomeSDK::Models::Tier>, nil)

# File 'lib/metronome_sdk/models/override.rb', line 111

optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }

#type ⇒ Symbol, ...

Returns:

• (Symbol, MetronomeSDK::Models::Override::Type, nil)

# File 'lib/metronome_sdk/models/override.rb', line 116

optional :type, enum: -> { MetronomeSDK::Override::Type }

#value ⇒ Hash{Symbol=>Object}^?

Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/metronome_sdk/models/override.rb', line 123

optional :value, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/override.rb', line 233

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/override.rbs', line 153

def to_hash: -> {