Class: MetronomeSDK::Models::V1::ContractCreateParams::Override

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/metronome_sdk/models/v1/contract_create_params.rb,
sig/metronome_sdk/models/v1/contract_create_params.rbs

Defined Under Namespace

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

Instance Attribute Summary

• #applicable_product_tags ⇒ Array<String>^?

  tags identifying products whose rates are being overridden.

• #ending_before ⇒ Time^?

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

• #entitled ⇒ Boolean^?
• #is_commit_specific ⇒ Boolean^?

  Indicates whether the override should only apply to commits.

• #multiplier ⇒ Float^?

  Required for MULTIPLIER type.

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

  Cannot be used in conjunction with product_id or applicable_product_tags.

• #overwrite_rate ⇒ MetronomeSDK::Models::V1::ContractCreateParams::Override::OverwriteRate^?

  Required for OVERWRITE type.

• #priority ⇒ Float^?

  Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.

• #product_id ⇒ String^?

  ID of the product whose rate is being overridden.

• #starting_at ⇒ Time

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

• #target ⇒ Symbol, ...

  Indicates whether the override applies to commit rates or list rates.

• #tiers ⇒ Array<MetronomeSDK::Models::V1::ContractCreateParams::Override::Tier>^?

  Required for TIERED type.

• #type ⇒ Symbol, ...

  Overwrites are prioritized over multipliers and tiered overrides.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

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

Parameters:

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

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1725

Instance Attribute Details

#applicable_product_tags ⇒ Array<String>^?

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

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1409

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

#ending_before ⇒ Time^?

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

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1415

optional :ending_before, Time

#entitled ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1420

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, recurring_commit_ids, or any_commit_or_credit_ids. If you do not specify any of these fields, the override will apply when consuming any prepaid commit, postpaid commit, or credit

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1430

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

#multiplier ⇒ Float^?

Required for MULTIPLIER type. Must be >=0.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1436

optional :multiplier, Float

#override_specifiers ⇒ Array<MetronomeSDK::Models::V1::ContractCreateParams::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:

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

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1443

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

#overwrite_rate ⇒ MetronomeSDK::Models::V1::ContractCreateParams::Override::OverwriteRate^?

Required for OVERWRITE type.

Returns:

• (MetronomeSDK::Models::V1::ContractCreateParams::Override::OverwriteRate, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1450

optional :overwrite_rate, -> { MetronomeSDK::V1::ContractCreateParams::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.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1459

optional :priority, Float

#product_id ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1466

optional :product_id, String

#starting_at ⇒ Time

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

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1402

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:

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

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1474

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

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

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

Returns:

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

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1480

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

#type ⇒ Symbol, ...

Overwrites are prioritized over multipliers and tiered overrides.

Returns:

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

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1487

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1611

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/v1/contract_create_params.rbs', line 1344

def to_hash: -> {