Class: Inttegro::BalanceTransaction::AllocationBase

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/balance_transaction/allocation_base.rb

Overview

Typed representation of the allocation base 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

#completed_at ⇒ Time? (readonly)

When the allocated amount became permanently consumed. Present only when status is completed.

Optional in the API payload; omitted values default to nil. Wire name: completed_at.

Returns:

  • (Time, nil) 


57
58
59
60
61
62
63
64
 
# File 'lib/inttegro/balance_transaction/allocation_base.rb', line 57

class AllocationBase < T::Struct
  const :completed_at, T.nilable(Time), default: nil
  const :created_at, Time
  const :id, String
  const :status, Inttegro::BalanceTransaction::AllocationStatus
  const :type, Inttegro::BalanceTransaction::AllocationBaseType
  const :updated_at, Time
end

#created_at ⇒ Time (readonly)

When the amount first became unavailable for another refund or payout.

Required in the API payload. Wire name: created_at.

Returns:

  • (Time) 


57
58
59
60
61
62
63
64
 
# File 'lib/inttegro/balance_transaction/allocation_base.rb', line 57

class AllocationBase < T::Struct
  const :completed_at, T.nilable(Time), default: nil
  const :created_at, Time
  const :id, String
  const :status, Inttegro::BalanceTransaction::AllocationStatus
  const :type, Inttegro::BalanceTransaction::AllocationBaseType
  const :updated_at, Time
end

#id ⇒ String (readonly)

Stable public allocation identifier for reconciliation and support.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


57
58
59
60
61
62
63
64
 
# File 'lib/inttegro/balance_transaction/allocation_base.rb', line 57

class AllocationBase < T::Struct
  const :completed_at, T.nilable(Time), default: nil
  const :created_at, Time
  const :id, String
  const :status, Inttegro::BalanceTransaction::AllocationStatus
  const :type, Inttegro::BalanceTransaction::AllocationBaseType
  const :updated_at, Time
end

#status ⇒ Inttegro::BalanceTransaction::AllocationStatus (readonly)

Public effect of an allocation on the source payment balance transaction. Internal reservation and reconciliation states are not exposed.

Required in the API payload. Wire name: status.

Returns:



57
58
59
60
61
62
63
64
 
# File 'lib/inttegro/balance_transaction/allocation_base.rb', line 57

class AllocationBase < T::Struct
  const :completed_at, T.nilable(Time), default: nil
  const :created_at, Time
  const :id, String
  const :status, Inttegro::BalanceTransaction::AllocationStatus
  const :type, Inttegro::BalanceTransaction::AllocationBaseType
  const :updated_at, Time
end

#type ⇒ Inttegro::BalanceTransaction::AllocationBaseType (readonly)

Value of the type field in the Inttegro API payload.

Required in the API payload. Wire name: type.

Returns:



57
58
59
60
61
62
63
64
 
# File 'lib/inttegro/balance_transaction/allocation_base.rb', line 57

class AllocationBase < T::Struct
  const :completed_at, T.nilable(Time), default: nil
  const :created_at, Time
  const :id, String
  const :status, Inttegro::BalanceTransaction::AllocationStatus
  const :type, Inttegro::BalanceTransaction::AllocationBaseType
  const :updated_at, Time
end

#updated_at ⇒ Time (readonly)

When the public allocation status last changed.

Required in the API payload. Wire name: updated_at.

Returns:

  • (Time) 


57
58
59
60
61
62
63
64
 
# File 'lib/inttegro/balance_transaction/allocation_base.rb', line 57

class AllocationBase < T::Struct
  const :completed_at, T.nilable(Time), default: nil
  const :created_at, Time
  const :id, String
  const :status, Inttegro::BalanceTransaction::AllocationStatus
  const :type, Inttegro::BalanceTransaction::AllocationBaseType
  const :updated_at, Time
end