Class: ModernTreasury::LedgerTransactionVersion

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/modern_treasury/models/ledger_transaction_version.rb

Overview

LedgerTransactionVersion Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(id:, object:, live_mode:, created_at:, ledger_transaction_id:, description:, status:, metadata:, effective_at:, effective_date:, ledger_entries:, posted_at:, ledger_id:, ledgerable_type:, ledgerable_id:, external_id:, version:) ⇒ LedgerTransactionVersion

Returns a new instance of LedgerTransactionVersion.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 131

def initialize(id:, object:, live_mode:, created_at:,
               ledger_transaction_id:, description:, status:, metadata:,
               effective_at:, effective_date:, ledger_entries:, posted_at:,
               ledger_id:, ledgerable_type:, ledgerable_id:, external_id:,
               version:)
  @id = id
  @object = object
  @live_mode = live_mode
  @created_at = created_at
  @ledger_transaction_id = ledger_transaction_id
  @description = description
  @status = status
  @metadata = metadata
  @effective_at = effective_at
  @effective_date = effective_date
  @ledger_entries = ledger_entries
  @posted_at = posted_at
  @ledger_id = ledger_id
  @ledgerable_type = ledgerable_type
  @ledgerable_id = ledgerable_id
  @external_id = external_id
  @version = version
end

Instance Attribute Details

#created_at ⇒ DateTime

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

Returns:

  • (DateTime) 


29
30
31
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 29

def created_at
  @created_at
end

#description ⇒ String

An optional description for internal use.

Returns:

  • (String) 


37
38
39
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 37

def description
  @description
end

#effective_at ⇒ DateTime

The timestamp (ISO8601 format) at which the ledger transaction happened for reporting purposes.

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 51

def effective_at
  @effective_at
end

#effective_date ⇒ Date

The date (YYYY-MM-DD) on which the ledger transaction happened for reporting purposes.

Returns:

  • (Date) 


56
57
58
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 56

def effective_date
  @effective_date
end

#external_id ⇒ String

A unique string to represent the ledger transaction. Only one pending or posted ledger transaction may have this ID in the ledger.

Returns:

  • (String) 


86
87
88
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 86

def external_id
  @external_id
end

#id ⇒ UUID | String

TODO: Write general description for this method

Returns:

  • (UUID | String) 


15
16
17
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 15

def id
  @id
end

#ledger_entries ⇒ Array[LedgerEntryOfTransactionVersion]

An array of ledger entry objects.

Returns:



60
61
62
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 60

def ledger_entries
  @ledger_entries
end

#ledger_id ⇒ UUID | String

The ID of the ledger this ledger transaction belongs to.

Returns:

  • (UUID | String) 


69
70
71
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 69

def ledger_id
  @ledger_id
end

#ledger_transaction_id ⇒ UUID | String

The ID of the ledger transaction

Returns:

  • (UUID | String) 


33
34
35
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 33

def ledger_transaction_id
  @ledger_transaction_id
end

#ledgerable_id ⇒ UUID | String

If the ledger transaction can be reconciled to another object in Modern Treasury, the id will be populated here, otherwise null.

Returns:

  • (UUID | String) 


81
82
83
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 81

def ledgerable_id
  @ledgerable_id
end

#ledgerable_type ⇒ LedgerableType2

If the ledger transaction can be reconciled to another object in Modern Treasury, the type will be populated here, otherwise null. This can be one of payment_order, incoming_payment_detail, expected_payment, return, or reversal.

Returns:



76
77
78
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 76

def ledgerable_type
  @ledgerable_type
end

#live_mode ⇒ TrueClass | FalseClass

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

Returns:

  • (TrueClass | FalseClass) 


24
25
26
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 24

def live_mode
  @live_mode
end

#metadata ⇒ Hash[String, String]

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

Returns:

  • (Hash[String, String]) 


46
47
48
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 46

def metadata
  @metadata
end

#object ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


19
20
21
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 19

def object
  @object
end

#posted_at ⇒ DateTime

The time on which the ledger transaction posted. This is null if the ledger transaction is pending.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 65

def posted_at
  @posted_at
end

#status ⇒ Status12

One of ‘pending`, `posted`, or `archived`

Returns:



41
42
43
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 41

def status
  @status
end

#version ⇒ Integer

Version number of the ledger transaction.

Returns:

  • (Integer) 


90
91
92
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 90

def version
  @version
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 156

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : nil
  object = hash.key?('object') ? hash['object'] : nil
  live_mode = hash.key?('live_mode') ? hash['live_mode'] : nil
  created_at = if hash.key?('created_at')
                 (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
               end
  ledger_transaction_id =
    hash.key?('ledger_transaction_id') ? hash['ledger_transaction_id'] : nil
  description = hash.key?('description') ? hash['description'] : nil
  status = hash.key?('status') ? hash['status'] : nil
  metadata = hash.key?('metadata') ? hash['metadata'] : nil
  effective_at = if hash.key?('effective_at')
                   (DateTimeHelper.from_rfc3339(hash['effective_at']) if hash['effective_at'])
                 end
  effective_date =
    hash.key?('effective_date') ? hash['effective_date'] : nil
  # Parameter is an array, so we need to iterate through it
  ledger_entries = nil
  unless hash['ledger_entries'].nil?
    ledger_entries = []
    hash['ledger_entries'].each do |structure|
      ledger_entries << (LedgerEntryOfTransactionVersion.from_hash(structure) if structure)
    end
  end

  ledger_entries = nil unless hash.key?('ledger_entries')
  posted_at = if hash.key?('posted_at')
                (DateTimeHelper.from_rfc3339(hash['posted_at']) if hash['posted_at'])
              end
  ledger_id = hash.key?('ledger_id') ? hash['ledger_id'] : nil
  ledgerable_type =
    hash.key?('ledgerable_type') ? hash['ledgerable_type'] : nil
  ledgerable_id = hash.key?('ledgerable_id') ? hash['ledgerable_id'] : nil
  external_id = hash.key?('external_id') ? hash['external_id'] : nil
  version = hash.key?('version') ? hash['version'] : nil

  # Create object from extracted values.
  LedgerTransactionVersion.new(id: id,
                               object: object,
                               live_mode: live_mode,
                               created_at: created_at,
                               ledger_transaction_id: ledger_transaction_id,
                               description: description,
                               status: status,
                               metadata: metadata,
                               effective_at: effective_at,
                               effective_date: effective_date,
                               ledger_entries: ledger_entries,
                               posted_at: posted_at,
                               ledger_id: ledger_id,
                               ledgerable_type: ledgerable_type,
                               ledgerable_id: ledgerable_id,
                               external_id: external_id,
                               version: version)
end

.names ⇒ Object

A mapping from model property names to API property names.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 93

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['object'] = 'object'
  @_hash['live_mode'] = 'live_mode'
  @_hash['created_at'] = 'created_at'
  @_hash['ledger_transaction_id'] = 'ledger_transaction_id'
  @_hash['description'] = 'description'
  @_hash['status'] = 'status'
  @_hash['metadata'] = 'metadata'
  @_hash['effective_at'] = 'effective_at'
  @_hash['effective_date'] = 'effective_date'
  @_hash['ledger_entries'] = 'ledger_entries'
  @_hash['posted_at'] = 'posted_at'
  @_hash['ledger_id'] = 'ledger_id'
  @_hash['ledgerable_type'] = 'ledgerable_type'
  @_hash['ledgerable_id'] = 'ledgerable_id'
  @_hash['external_id'] = 'external_id'
  @_hash['version'] = 'version'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



121
122
123
124
125
126
127
128
129
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 121

def self.nullables
  %w[
    description
    posted_at
    ledgerable_type
    ledgerable_id
    external_id
  ]
end

.optionals ⇒ Object

An array for optional fields



116
117
118
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 116

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 240

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id.inspect}, object: #{@object.inspect}, live_mode:"\
  " #{@live_mode.inspect}, created_at: #{@created_at.inspect}, ledger_transaction_id:"\
  " #{@ledger_transaction_id.inspect}, description: #{@description.inspect}, status:"\
  " #{@status.inspect}, metadata: #{@metadata.inspect}, effective_at:"\
  " #{@effective_at.inspect}, effective_date: #{@effective_date.inspect}, ledger_entries:"\
  " #{@ledger_entries.inspect}, posted_at: #{@posted_at.inspect}, ledger_id:"\
  " #{@ledger_id.inspect}, ledgerable_type: #{@ledgerable_type.inspect}, ledgerable_id:"\
  " #{@ledgerable_id.inspect}, external_id: #{@external_id.inspect}, version:"\
  " #{@version.inspect}>"
end

#to_custom_created_at ⇒ Object 



216
217
218
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 216

def to_custom_created_at
  DateTimeHelper.to_rfc3339(created_at)
end

#to_custom_effective_at ⇒ Object 



220
221
222
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 220

def to_custom_effective_at
  DateTimeHelper.to_rfc3339(effective_at)
end

#to_custom_posted_at ⇒ Object 



224
225
226
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 224

def to_custom_posted_at
  DateTimeHelper.to_rfc3339(posted_at)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



229
230
231
232
233
234
235
236
237
 
# File 'lib/modern_treasury/models/ledger_transaction_version.rb', line 229

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id}, object: #{@object}, live_mode: #{@live_mode}, created_at:"\
  " #{@created_at}, ledger_transaction_id: #{@ledger_transaction_id}, description:"\
  " #{@description}, status: #{@status}, metadata: #{@metadata}, effective_at:"\
  " #{@effective_at}, effective_date: #{@effective_date}, ledger_entries: #{@ledger_entries},"\
  " posted_at: #{@posted_at}, ledger_id: #{@ledger_id}, ledgerable_type: #{@ledgerable_type},"\
  " ledgerable_id: #{@ledgerable_id}, external_id: #{@external_id}, version: #{@version}>"
end