Class: Atrium::Transaction

Inherits:
Object
  • Object
show all
Defined in:
lib/atrium-ruby/models/transaction.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



155
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/atrium-ruby/models/transaction.rb', line 155

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'account_guid')
    self. = attributes[:'account_guid']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'category')
    self.category = attributes[:'category']
  end

  if attributes.has_key?(:'check_number')
    self.check_number = attributes[:'check_number']
  end

  if attributes.has_key?(:'check_number_string')
    self.check_number_string = attributes[:'check_number_string']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end

  if attributes.has_key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'guid')
    self.guid = attributes[:'guid']
  end

  if attributes.has_key?(:'is_bill_pay')
    self.is_bill_pay = attributes[:'is_bill_pay']
  end

  if attributes.has_key?(:'is_direct_deposit')
    self.is_direct_deposit = attributes[:'is_direct_deposit']
  end

  if attributes.has_key?(:'is_expense')
    self.is_expense = attributes[:'is_expense']
  end

  if attributes.has_key?(:'is_fee')
    self.is_fee = attributes[:'is_fee']
  end

  if attributes.has_key?(:'is_income')
    self.is_income = attributes[:'is_income']
  end

  if attributes.has_key?(:'is_international')
    self.is_international = attributes[:'is_international']
  end

  if attributes.has_key?(:'is_overdraft_fee')
    self.is_overdraft_fee = attributes[:'is_overdraft_fee']
  end

  if attributes.has_key?(:'is_payroll_advance')
    self.is_payroll_advance = attributes[:'is_payroll_advance']
  end

  if attributes.has_key?(:'latitude')
    self.latitude = attributes[:'latitude']
  end

  if attributes.has_key?(:'longitude')
    self.longitude = attributes[:'longitude']
  end

  if attributes.has_key?(:'member_guid')
    self.member_guid = attributes[:'member_guid']
  end

  if attributes.has_key?(:'memo')
    self.memo = attributes[:'memo']
  end

  if attributes.has_key?(:'merchant_category_code')
    self.merchant_category_code = attributes[:'merchant_category_code']
  end

  if attributes.has_key?(:'merchant_guid')
    self.merchant_guid = attributes[:'merchant_guid']
  end

  if attributes.has_key?(:'original_description')
    self.original_description = attributes[:'original_description']
  end

  if attributes.has_key?(:'posted_at')
    self.posted_at = attributes[:'posted_at']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'top_level_category')
    self.top_level_category = attributes[:'top_level_category']
  end

  if attributes.has_key?(:'transacted_at')
    self.transacted_at = attributes[:'transacted_at']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.has_key?(:'user_guid')
    self.user_guid = attributes[:'user_guid']
  end
end

Instance Attribute Details

#account_guid ⇒ Object

Returns the value of attribute account_guid.



13
14
15
 
# File 'lib/atrium-ruby/models/transaction.rb', line 13

def 
  @account_guid
end

#amount ⇒ Object

Returns the value of attribute amount.



15
16
17
 
# File 'lib/atrium-ruby/models/transaction.rb', line 15

def amount
  @amount
end

#category ⇒ Object

Returns the value of attribute category.



17
18
19
 
# File 'lib/atrium-ruby/models/transaction.rb', line 17

def category
  @category
end

#check_number ⇒ Object

Returns the value of attribute check_number.



19
20
21
 
# File 'lib/atrium-ruby/models/transaction.rb', line 19

def check_number
  @check_number
end

#check_number_string ⇒ Object

Returns the value of attribute check_number_string.



21
22
23
 
# File 'lib/atrium-ruby/models/transaction.rb', line 21

def check_number_string
  @check_number_string
end

#created_at ⇒ Object

Returns the value of attribute created_at.



23
24
25
 
# File 'lib/atrium-ruby/models/transaction.rb', line 23

def created_at
  @created_at
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



25
26
27
 
# File 'lib/atrium-ruby/models/transaction.rb', line 25

def currency_code
  @currency_code
end

#date ⇒ Object

Returns the value of attribute date.



27
28
29
 
# File 'lib/atrium-ruby/models/transaction.rb', line 27

def date
  @date
end

#description ⇒ Object

Returns the value of attribute description.



29
30
31
 
# File 'lib/atrium-ruby/models/transaction.rb', line 29

def description
  @description
end

#guid ⇒ Object

Returns the value of attribute guid.



31
32
33
 
# File 'lib/atrium-ruby/models/transaction.rb', line 31

def guid
  @guid
end

#is_bill_pay ⇒ Object

Returns the value of attribute is_bill_pay.



33
34
35
 
# File 'lib/atrium-ruby/models/transaction.rb', line 33

def is_bill_pay
  @is_bill_pay
end

#is_direct_deposit ⇒ Object

Returns the value of attribute is_direct_deposit.



35
36
37
 
# File 'lib/atrium-ruby/models/transaction.rb', line 35

def is_direct_deposit
  @is_direct_deposit
end

#is_expense ⇒ Object

Returns the value of attribute is_expense.



37
38
39
 
# File 'lib/atrium-ruby/models/transaction.rb', line 37

def is_expense
  @is_expense
end

#is_fee ⇒ Object

Returns the value of attribute is_fee.



39
40
41
 
# File 'lib/atrium-ruby/models/transaction.rb', line 39

def is_fee
  @is_fee
end

#is_income ⇒ Object

Returns the value of attribute is_income.



41
42
43
 
# File 'lib/atrium-ruby/models/transaction.rb', line 41

def is_income
  @is_income
end

#is_international ⇒ Object

Returns the value of attribute is_international.



43
44
45
 
# File 'lib/atrium-ruby/models/transaction.rb', line 43

def is_international
  @is_international
end

#is_overdraft_fee ⇒ Object

Returns the value of attribute is_overdraft_fee.



45
46
47
 
# File 'lib/atrium-ruby/models/transaction.rb', line 45

def is_overdraft_fee
  @is_overdraft_fee
end

#is_payroll_advance ⇒ Object

Returns the value of attribute is_payroll_advance.



47
48
49
 
# File 'lib/atrium-ruby/models/transaction.rb', line 47

def is_payroll_advance
  @is_payroll_advance
end

#latitude ⇒ Object

Returns the value of attribute latitude.



49
50
51
 
# File 'lib/atrium-ruby/models/transaction.rb', line 49

def latitude
  @latitude
end

#longitude ⇒ Object

Returns the value of attribute longitude.



51
52
53
 
# File 'lib/atrium-ruby/models/transaction.rb', line 51

def longitude
  @longitude
end

#member_guid ⇒ Object

Returns the value of attribute member_guid.



53
54
55
 
# File 'lib/atrium-ruby/models/transaction.rb', line 53

def member_guid
  @member_guid
end

#memo ⇒ Object

Returns the value of attribute memo.



55
56
57
 
# File 'lib/atrium-ruby/models/transaction.rb', line 55

def memo
  @memo
end

#merchant_category_code ⇒ Object

Returns the value of attribute merchant_category_code.



57
58
59
 
# File 'lib/atrium-ruby/models/transaction.rb', line 57

def merchant_category_code
  @merchant_category_code
end

#merchant_guid ⇒ Object

Returns the value of attribute merchant_guid.



59
60
61
 
# File 'lib/atrium-ruby/models/transaction.rb', line 59

def merchant_guid
  @merchant_guid
end

#original_description ⇒ Object

Returns the value of attribute original_description.



61
62
63
 
# File 'lib/atrium-ruby/models/transaction.rb', line 61

def original_description
  @original_description
end

#posted_at ⇒ Object

Returns the value of attribute posted_at.



63
64
65
 
# File 'lib/atrium-ruby/models/transaction.rb', line 63

def posted_at
  @posted_at
end

#status ⇒ Object

Returns the value of attribute status.



65
66
67
 
# File 'lib/atrium-ruby/models/transaction.rb', line 65

def status
  @status
end

#top_level_category ⇒ Object

Returns the value of attribute top_level_category.



67
68
69
 
# File 'lib/atrium-ruby/models/transaction.rb', line 67

def top_level_category
  @top_level_category
end

#transacted_at ⇒ Object

Returns the value of attribute transacted_at.



69
70
71
 
# File 'lib/atrium-ruby/models/transaction.rb', line 69

def transacted_at
  @transacted_at
end

#type ⇒ Object

Returns the value of attribute type.



71
72
73
 
# File 'lib/atrium-ruby/models/transaction.rb', line 71

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



73
74
75
 
# File 'lib/atrium-ruby/models/transaction.rb', line 73

def updated_at
  @updated_at
end

#user_guid ⇒ Object

Returns the value of attribute user_guid.



75
76
77
 
# File 'lib/atrium-ruby/models/transaction.rb', line 75

def user_guid
  @user_guid
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/atrium-ruby/models/transaction.rb', line 78

def self.attribute_map
  {
    :'account_guid' => :'account_guid',
    :'amount' => :'amount',
    :'category' => :'category',
    :'check_number' => :'check_number',
    :'check_number_string' => :'check_number_string',
    :'created_at' => :'created_at',
    :'currency_code' => :'currency_code',
    :'date' => :'date',
    :'description' => :'description',
    :'guid' => :'guid',
    :'is_bill_pay' => :'is_bill_pay',
    :'is_direct_deposit' => :'is_direct_deposit',
    :'is_expense' => :'is_expense',
    :'is_fee' => :'is_fee',
    :'is_income' => :'is_income',
    :'is_international' => :'is_international',
    :'is_overdraft_fee' => :'is_overdraft_fee',
    :'is_payroll_advance' => :'is_payroll_advance',
    :'latitude' => :'latitude',
    :'longitude' => :'longitude',
    :'member_guid' => :'member_guid',
    :'memo' => :'memo',
    :'merchant_category_code' => :'merchant_category_code',
    :'merchant_guid' => :'merchant_guid',
    :'original_description' => :'original_description',
    :'posted_at' => :'posted_at',
    :'status' => :'status',
    :'top_level_category' => :'top_level_category',
    :'transacted_at' => :'transacted_at',
    :'type' => :'type',
    :'updated_at' => :'updated_at',
    :'user_guid' => :'user_guid'
  }
end

.mx_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/atrium-ruby/models/transaction.rb', line 116

def self.mx_types
  {
    :'account_guid' => :'String',
    :'amount' => :'Float',
    :'category' => :'String',
    :'check_number' => :'Integer',
    :'check_number_string' => :'String',
    :'created_at' => :'String',
    :'currency_code' => :'String',
    :'date' => :'String',
    :'description' => :'String',
    :'guid' => :'String',
    :'is_bill_pay' => :'BOOLEAN',
    :'is_direct_deposit' => :'BOOLEAN',
    :'is_expense' => :'BOOLEAN',
    :'is_fee' => :'BOOLEAN',
    :'is_income' => :'BOOLEAN',
    :'is_international' => :'BOOLEAN',
    :'is_overdraft_fee' => :'BOOLEAN',
    :'is_payroll_advance' => :'BOOLEAN',
    :'latitude' => :'Float',
    :'longitude' => :'Float',
    :'member_guid' => :'String',
    :'memo' => :'String',
    :'merchant_category_code' => :'Integer',
    :'merchant_guid' => :'String',
    :'original_description' => :'String',
    :'posted_at' => :'String',
    :'status' => :'String',
    :'top_level_category' => :'String',
    :'transacted_at' => :'String',
    :'type' => :'String',
    :'updated_at' => :'String',
    :'user_guid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/atrium-ruby/models/transaction.rb', line 305

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      amount == o.amount &&
      category == o.category &&
      check_number == o.check_number &&
      check_number_string == o.check_number_string &&
      created_at == o.created_at &&
      currency_code == o.currency_code &&
      date == o.date &&
      description == o.description &&
      guid == o.guid &&
      is_bill_pay == o.is_bill_pay &&
      is_direct_deposit == o.is_direct_deposit &&
      is_expense == o.is_expense &&
      is_fee == o.is_fee &&
      is_income == o.is_income &&
      is_international == o.is_international &&
      is_overdraft_fee == o.is_overdraft_fee &&
      is_payroll_advance == o.is_payroll_advance &&
      latitude == o.latitude &&
      longitude == o.longitude &&
      member_guid == o.member_guid &&
      memo == o.memo &&
      merchant_category_code == o.merchant_category_code &&
      merchant_guid == o.merchant_guid &&
      original_description == o.original_description &&
      posted_at == o.posted_at &&
      status == o.status &&
      top_level_category == o.top_level_category &&
      transacted_at == o.transacted_at &&
      type == o.type &&
      updated_at == o.updated_at &&
      user_guid == o.user_guid
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/atrium-ruby/models/transaction.rb', line 378

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Atrium.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/atrium-ruby/models/transaction.rb', line 444

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/atrium-ruby/models/transaction.rb', line 357

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.mx_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


344
345
346
 
# File 'lib/atrium-ruby/models/transaction.rb', line 344

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



350
351
352
 
# File 'lib/atrium-ruby/models/transaction.rb', line 350

def hash
  [, amount, category, check_number, check_number_string, created_at, currency_code, date, description, guid, is_bill_pay, is_direct_deposit, is_expense, is_fee, is_income, is_international, is_overdraft_fee, is_payroll_advance, latitude, longitude, member_guid, memo, merchant_category_code, merchant_guid, original_description, posted_at, status, top_level_category, transacted_at, type, updated_at, user_guid].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



292
293
294
295
 
# File 'lib/atrium-ruby/models/transaction.rb', line 292

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



424
425
426
 
# File 'lib/atrium-ruby/models/transaction.rb', line 424

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



430
431
432
433
434
435
436
437
438
 
# File 'lib/atrium-ruby/models/transaction.rb', line 430

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



418
419
420
 
# File 'lib/atrium-ruby/models/transaction.rb', line 418

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



299
300
301
 
# File 'lib/atrium-ruby/models/transaction.rb', line 299

def valid?
  true
end