Class: Inttegro::Balance::CurrencySnapshot

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/balance/currency_snapshot.rb

Overview

Typed representation of the currency snapshot object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#available ⇒ Inttegro::Balance::Value (readonly)

Value of the available field in the Inttegro API payload.

Required in the API payload. Wire name: available.

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/balance/currency_snapshot.rb', line 58

class CurrencySnapshot < T::Struct
  const :available, Inttegro::Balance::Value
  const :held, Inttegro::Balance::Holds
  const :includes_transactions_before, Time
  const :pending, Inttegro::Balance::Value
  const :refund, Inttegro::Balance::CurrencySnapshotRefund
  const :reserved, Inttegro::Balance::CurrencySnapshotReserved
end

#held ⇒ Inttegro::Balance::Holds (readonly)

Live operational commitments read from the canonical balance position.

Required in the API payload. Wire name: held.

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/balance/currency_snapshot.rb', line 58

class CurrencySnapshot < T::Struct
  const :available, Inttegro::Balance::Value
  const :held, Inttegro::Balance::Holds
  const :includes_transactions_before, Time
  const :pending, Inttegro::Balance::Value
  const :refund, Inttegro::Balance::CurrencySnapshotRefund
  const :reserved, Inttegro::Balance::CurrencySnapshotReserved
end

#includes_transactions_before ⇒ Time (readonly)

The snapshot includes transactions created before this timestamp

Required in the API payload. Wire name: includes_transactions_before.

Returns:

  • (Time) 


58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/balance/currency_snapshot.rb', line 58

class CurrencySnapshot < T::Struct
  const :available, Inttegro::Balance::Value
  const :held, Inttegro::Balance::Holds
  const :includes_transactions_before, Time
  const :pending, Inttegro::Balance::Value
  const :refund, Inttegro::Balance::CurrencySnapshotRefund
  const :reserved, Inttegro::Balance::CurrencySnapshotReserved
end

#pending ⇒ Inttegro::Balance::Value (readonly)

Value of the pending field in the Inttegro API payload.

Required in the API payload. Wire name: pending.

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/balance/currency_snapshot.rb', line 58

class CurrencySnapshot < T::Struct
  const :available, Inttegro::Balance::Value
  const :held, Inttegro::Balance::Holds
  const :includes_transactions_before, Time
  const :pending, Inttegro::Balance::Value
  const :refund, Inttegro::Balance::CurrencySnapshotRefund
  const :reserved, Inttegro::Balance::CurrencySnapshotReserved
end

#refund ⇒ Inttegro::Balance::CurrencySnapshotRefund (readonly)

Funds intentionally earmarked for future refund obligations at the snapshot cutoff

Required in the API payload. Wire name: refund.

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/balance/currency_snapshot.rb', line 58

class CurrencySnapshot < T::Struct
  const :available, Inttegro::Balance::Value
  const :held, Inttegro::Balance::Holds
  const :includes_transactions_before, Time
  const :pending, Inttegro::Balance::Value
  const :refund, Inttegro::Balance::CurrencySnapshotRefund
  const :reserved, Inttegro::Balance::CurrencySnapshotReserved
end

#reserved ⇒ Inttegro::Balance::CurrencySnapshotReserved (readonly)

Funds intentionally reserved for policy, risk, or remediation purposes at the snapshot cutoff

Required in the API payload. Wire name: reserved.

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/balance/currency_snapshot.rb', line 58

class CurrencySnapshot < T::Struct
  const :available, Inttegro::Balance::Value
  const :held, Inttegro::Balance::Holds
  const :includes_transactions_before, Time
  const :pending, Inttegro::Balance::Value
  const :refund, Inttegro::Balance::CurrencySnapshotRefund
  const :reserved, Inttegro::Balance::CurrencySnapshotReserved
end