Class: ModernTreasury::Models::LedgerAccountBalanceMonitor

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/ledger_account_balance_monitor.rb

Overview

See Also:

Defined Under Namespace

Classes: AlertCondition, CurrentLedgerAccountBalanceState

Instance Attribute 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(field: , operator: , value: ) ⇒ Object

Some parameter documentations has been truncated, see AlertCondition for more details.

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

Parameters:

  • field (String) (defaults to: ) —

    One of ‘available_balance_amount`, `pending_balance_amount`, `posted_balance_amo

  • operator (String) (defaults to: ) —

    A logical operator to compare the ‘field` against the `value`. One of `less_than

  • value (Integer) (defaults to: ) —

    The monitor’s ‘current_ledger_account_balance_state.triggered` will be `true` wh




# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 72

Instance Attribute Details

#alert_condition ⇒ ModernTreasury::Models::LedgerAccountBalanceMonitor::AlertCondition

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

Returns:



16
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 16

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

#created_at ⇒ Time

Returns:

  • (Time) 


21
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 21

required :created_at, Time

#current_ledger_account_balance_state ⇒ ModernTreasury::Models::LedgerAccountBalanceMonitor::CurrentLedgerAccountBalanceState

The ledger account’s balances and the monitor state as of the current ledger account lock version.

Returns:



28
29
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 28

required :current_ledger_account_balance_state,
-> { ModernTreasury::LedgerAccountBalanceMonitor::CurrentLedgerAccountBalanceState }

#description ⇒ String?

An optional, free-form description for internal use.

Returns:

  • (String, nil) 


35
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 35

required :description, String, nil?: true

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


40
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 40

required :discarded_at, Time, nil?: true

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 10

required :id, String

#ledger_account_id ⇒ String

The ledger account associated with this balance monitor.

Returns:

  • (String) 


46
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 46

required :ledger_account_id, String

#live_mode ⇒ Boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (Boolean) 


53
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 53

required :live_mode, ModernTreasury::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String}

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

Returns:

  • (Hash{Symbol=>String}) 


60
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 60

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

#object ⇒ String

Returns:

  • (String) 


65
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 65

required :object, String

#updated_at ⇒ Time

Returns:

  • (Time) 


70
 
# File 'lib/modern_treasury/models/ledger_account_balance_monitor.rb', line 70

required :updated_at, Time