Class: MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit

Inherits:
UpdateBaseThresholdCommit show all
Defined in:
lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes inherited from UpdateBaseThresholdCommit

#description, #name, #product_id

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(applicable_product_ids: nil, applicable_product_tags: nil, specifiers: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit for more details.

Parameters:

  • applicable_product_ids (Array<String>) (defaults to: nil)

    Which products the threshold commit applies to. If applicable_product_ids, appli

  • applicable_product_tags (Array<String>) (defaults to: nil)

    Which tags the threshold commit applies to. If applicable_product_ids, applicabl

  • specifiers (Array<MetronomeSDK::Models::CommitSpecifierInput>) (defaults to: nil)

    List of filters that determine what kind of customer usage draws down a commit o



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


Instance Attribute Details

#applicable_product_idsArray<String>?

Which products the threshold commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

Returns:

  • (Array<String>, nil)


68
# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb', line 68

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

#applicable_product_tagsArray<String>?

Which tags the threshold commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

Returns:

  • (Array<String>, nil)


76
# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb', line 76

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

#specifiersArray<MetronomeSDK::Models::CommitSpecifierInput>?

List of filters that determine what kind of customer usage draws down a commit or credit. A customer’s usage needs to meet the condition of at least one of the specifiers to contribute to a commit’s or credit’s drawdown. This field cannot be used together with ‘applicable_product_ids` or `applicable_product_tags`. Instead, to target usage by product or product tag, pass those values in the body of `specifiers`.



87
# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb', line 87

optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }