Class: ModernTreasury::Models::InternalAccounts::BalanceReport

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

Overview

See Also:

Defined Under Namespace

Modules: BalanceReportType Classes: Balance

Instance Attribute Summary collapse

Class Method 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(id: , as_of_date: , as_of_time: , balance_report_type: , balances: , created_at: , internal_account_id: , live_mode: , object: , updated_at: ) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::InternalAccounts::BalanceReport for more details.

Parameters:

  • id (String) (defaults to: )
  • as_of_date (Date) (defaults to: ) —

    The date of the balance report in local time.

  • as_of_time (Time, nil) (defaults to: ) —

    The time (24-hour clock) of the balance report in local time.

  • balance_report_type (Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType) (defaults to: ) —

    The specific type of balance report. One of ‘intraday`, `previous_day`, `real_ti

  • balances (Array<ModernTreasury::Models::InternalAccounts::BalanceReport::Balance>) (defaults to: ) —

    An array of ‘Balance` objects.

  • created_at (Time) (defaults to: )
  • internal_account_id (String) (defaults to: ) —

    The ID of one of your organization’s Internal Accounts.

  • live_mode (Boolean) (defaults to: ) —

    This field will be true if this object exists in the live environment or false i

  • object (String) (defaults to: )
  • updated_at (Time) (defaults to: ) 



# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 68

Instance Attribute Details

#as_of_date ⇒ Date

The date of the balance report in local time.

Returns:

  • (Date) 


17
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 17

required :as_of_date, Date

#as_of_time ⇒ Time?

The time (24-hour clock) of the balance report in local time.

Returns:

  • (Time, nil) 


23
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 23

required :as_of_time, Time, nil?: true

#balance_report_type ⇒ Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType

The specific type of balance report. One of ‘intraday`, `previous_day`, `real_time`, or `other`.

Returns:



30
31
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 30

required :balance_report_type,
enum: -> { ModernTreasury::InternalAccounts::BalanceReport::BalanceReportType }

#balances ⇒ Array<ModernTreasury::Models::InternalAccounts::BalanceReport::Balance>

An array of ‘Balance` objects.

Returns:



37
38
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 37

required :balances,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::InternalAccounts::BalanceReport::Balance] }

#created_at ⇒ Time

Returns:

  • (Time) 


43
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 43

required :created_at, Time

#id ⇒ String

Returns:

  • (String) 


11
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 11

required :id, String

#internal_account_id ⇒ String

The ID of one of your organization’s Internal Accounts.

Returns:

  • (String) 


49
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 49

required :internal_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) 


56
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 56

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

#object ⇒ String

Returns:

  • (String) 


61
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 61

required :object, String

#updated_at ⇒ Time

Returns:

  • (Time) 


66
 
# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 66

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/internal_accounts/balance_report.rb', line 104