Class: MetronomeSDK::Models::V1::ContractAmendParams::Override

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/contract_amend_params.rb

Defined Under Namespace

Modules: Target, Type Classes: OverrideSpecifier, OverwriteRate, Tier

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(multiplier:, size: nil) ⇒ Object

Parameters:

  • multiplier (Float)
  • size (Float) (defaults to: nil) 



# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1444

Instance Attribute Details

#applicable_product_tags ⇒ Array<String>?

tags identifying products whose rates are being overridden. Cannot be used in conjunction with override_specifiers.

Returns:

  • (Array<String>, nil) 


1142
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1142

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

#ending_before ⇒ Time?

RFC 3339 timestamp indicating when the override will stop applying (exclusive)

Returns:

  • (Time, nil) 


1148
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1148

optional :ending_before, Time

#entitled ⇒ Boolean?

Returns:

  • (Boolean, nil) 


1153
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1153

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

#is_commit_specific ⇒ Boolean?

Indicates whether the override should only apply to commits. Defaults to ‘false`. If `true`, you can specify relevant commits in `override_specifiers` by passing `commit_ids`. if you do not specify `commit_ids`, then the override will apply when consuming any prepaid or postpaid commit.

Returns:

  • (Boolean, nil) 


1162
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1162

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

#multiplier ⇒ Float?

Required for MULTIPLIER type. Must be >=0.

Returns:

  • (Float, nil) 


1168
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1168

optional :multiplier, Float

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

Cannot be used in conjunction with product_id or applicable_product_tags. If provided, the override will apply to all products with the specified specifiers.

Returns:



1175
1176
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1175

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

#overwrite_rate ⇒ MetronomeSDK::Models::V1::ContractAmendParams::Override::OverwriteRate?

Required for OVERWRITE type.

Returns:



1182
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1182

optional :overwrite_rate, -> { MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate }

#priority ⇒ Float?

Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides. Under EXPLICIT prioritization, overwrites are prioritized first, and then tiered and multiplier overrides are prioritized by their priority value (lowest first). Must be > 0.

Returns:

  • (Float, nil) 


1191
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1191

optional :priority, Float

#product_id ⇒ String?

ID of the product whose rate is being overridden. Cannot be used in conjunction with override_specifiers.

Returns:

  • (String, nil) 


1198
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1198

optional :product_id, String

#starting_at ⇒ Time

RFC 3339 timestamp indicating when the override will start applying (inclusive)

Returns:

  • (Time) 


1135
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1135

required :starting_at, Time

#target ⇒ Symbol, ...

Indicates whether the override applies to commit rates or list rates. Can only be used for overrides that have ‘is_commit_specific` set to `true`. Defaults to `“LIST_RATE”`.

Returns:



1206
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1206

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

#tiers ⇒ Array<MetronomeSDK::Models::V1::ContractAmendParams::Override::Tier>?

Required for TIERED type. Must have at least one tier.

Returns:



1212
1213
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1212

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

#type ⇒ Symbol, ...

Overwrites are prioritized over multipliers and tiered overrides.

Returns:



1219
 
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1219

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1331