Class: ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rb

Overview

See Also:

• Resources::LedgerAccountBalanceMonitors#create

Defined Under Namespace

Classes: AlertCondition

Instance Attribute Summary

• #alert_condition ⇒ ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition

  Describes the condition that must be satisfied for the monitor to be triggered.

• #description ⇒ String^?

  An optional, free-form description for internal use.

• #ledger_account_id ⇒ String

  The ledger account associated with this balance monitor.

• #metadata ⇒ Hash{Symbol=>String}^?

  Additional data represented as key-value pairs.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from ModernTreasury::Internal::Type::BaseModel

Instance Attribute Details

#alert_condition ⇒ ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition

Describes the condition that must be satisfied for the monitor to be triggered.

Returns:

• (ModernTreasury::Models::LedgerAccountBalanceMonitorCreateParams::AlertCondition)

# File 'lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rb', line 14

required :alert_condition, -> { ModernTreasury::LedgerAccountBalanceMonitorCreateParams::AlertCondition }

#description ⇒ String^?

An optional, free-form description for internal use.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rb', line 26

optional :description, String

#ledger_account_id ⇒ String

The ledger account associated with this balance monitor.

Returns:

• (String)

# File 'lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rb', line 20

required :ledger_account_id, String

#metadata ⇒ Hash{Symbol=>String}^?

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

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

# File 'lib/modern_treasury/models/ledger_account_balance_monitor_create_params.rb', line 33

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]