Class: MetronomeSDK::Models::V1::PackageCreateParams::Override

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/metronome_sdk/models/v1/package_create_params.rb

Defined Under Namespace

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

Instance Attribute Summary

• #duration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Override::Duration^?

  Offset relative to override start 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::PackageCreateParams::Override::OverrideSpecifier>

  Specifies which products the override will apply to.

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

  Required for OVERWRITE type.

• #priority ⇒ Float^?

  Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.

• #starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Override::StartingAtOffset

  Offset relative to contract start date 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::PackageCreateParams::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

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/package_create_params.rb', line 1251

Instance Attribute Details

#duration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Override::Duration^?

Offset relative to override start indicating when the override will stop applying (exclusive)

Returns:

• (MetronomeSDK::Models::V1::PackageCreateParams::Override::Duration, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 908

optional :duration, -> { MetronomeSDK::V1::PackageCreateParams::Override::Duration }

#entitled ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 913

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)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 922

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

#multiplier ⇒ Float^?

Required for MULTIPLIER type. Must be >=0.

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 928

optional :multiplier, Float

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

Specifies which products the override will apply to.

Returns:

• (Array<MetronomeSDK::Models::V1::PackageCreateParams::Override::OverrideSpecifier>)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 893

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

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

Required for OVERWRITE type.

Returns:

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

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 934

optional :overwrite_rate, -> { MetronomeSDK::V1::PackageCreateParams::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)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 943

optional :priority, Float

#starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Override::StartingAtOffset

Offset relative to contract start date indicating when the override will start applying (inclusive)

Returns:

• (MetronomeSDK::Models::V1::PackageCreateParams::Override::StartingAtOffset)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 901

required :starting_at_offset, -> { MetronomeSDK::V1::PackageCreateParams::Override::StartingAtOffset }

#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::PackageCreateParams::Override::Target, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 951

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

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

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

Returns:

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

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 957

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

#type ⇒ Symbol, ...

Overwrites are prioritized over multipliers and tiered overrides.

Returns:

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

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 964

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1072