Class: MxPlatformRuby::EnhanceTransactionResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/mx-platform-ruby/models/enhance_transaction_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnhanceTransactionResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 158

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::EnhanceTransactionResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MxPlatformRuby::EnhanceTransactionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'categorized_by')
    self.categorized_by = attributes[:'categorized_by']
  end

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

  if attributes.key?(:'category_guid')
    self.category_guid = attributes[:'category_guid']
  end

  if attributes.key?(:'described_by')
    self.described_by = attributes[:'described_by']
  end

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

  if attributes.key?(:'extended_transaction_type')
    self.extended_transaction_type = attributes[:'extended_transaction_type']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'is_subscription')
    self.is_subscription = attributes[:'is_subscription']
  end

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

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

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

  if attributes.key?(:'merchant_location_guid')
    self.merchant_location_guid = attributes[:'merchant_location_guid']
  end

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

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

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



18
19
20
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 18

def amount
  @amount
end

#categorized_by ⇒ Object

Returns the value of attribute categorized_by.



20
21
22
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 20

def categorized_by
  @categorized_by
end

#category ⇒ Object

Returns the value of attribute category.



22
23
24
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 22

def category
  @category
end

#category_guid ⇒ Object

Returns the value of attribute category_guid.



24
25
26
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 24

def category_guid
  @category_guid
end

#described_by ⇒ Object

Returns the value of attribute described_by.



26
27
28
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 26

def described_by
  @described_by
end

#description ⇒ Object

Returns the value of attribute description.



28
29
30
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 28

def description
  @description
end

#extended_transaction_type ⇒ Object

Returns the value of attribute extended_transaction_type.



30
31
32
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 30

def extended_transaction_type
  @extended_transaction_type
end

#id ⇒ Object

Returns the value of attribute id.



32
33
34
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 32

def id
  @id
end

#is_bill_pay ⇒ Object

Returns the value of attribute is_bill_pay.



34
35
36
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 34

def is_bill_pay
  @is_bill_pay
end

#is_direct_deposit ⇒ Object

Returns the value of attribute is_direct_deposit.



36
37
38
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 36

def is_direct_deposit
  @is_direct_deposit
end

#is_expense ⇒ Object

Returns the value of attribute is_expense.



38
39
40
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 38

def is_expense
  @is_expense
end

#is_fee ⇒ Object

Returns the value of attribute is_fee.



40
41
42
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 40

def is_fee
  @is_fee
end

#is_income ⇒ Object

Returns the value of attribute is_income.



42
43
44
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 42

def is_income
  @is_income
end

#is_international ⇒ Object

Returns the value of attribute is_international.



44
45
46
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 44

def is_international
  @is_international
end

#is_overdraft_fee ⇒ Object

Returns the value of attribute is_overdraft_fee.



46
47
48
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 46

def is_overdraft_fee
  @is_overdraft_fee
end

#is_payroll_advance ⇒ Object

Returns the value of attribute is_payroll_advance.



48
49
50
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 48

def is_payroll_advance
  @is_payroll_advance
end

#is_subscription ⇒ Object

Returns the value of attribute is_subscription.



50
51
52
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 50

def is_subscription
  @is_subscription
end

#memo ⇒ Object

Returns the value of attribute memo.



52
53
54
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 52

def memo
  @memo
end

#merchant_category_code ⇒ Object

Returns the value of attribute merchant_category_code.



54
55
56
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 54

def merchant_category_code
  @merchant_category_code
end

#merchant_guid ⇒ Object

Returns the value of attribute merchant_guid.



56
57
58
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 56

def merchant_guid
  @merchant_guid
end

#merchant_location_guid ⇒ Object

Returns the value of attribute merchant_location_guid.



58
59
60
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 58

def merchant_location_guid
  @merchant_location_guid
end

#original_description ⇒ Object

Returns the value of attribute original_description.



60
61
62
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 60

def original_description
  @original_description
end

#type ⇒ Object

Returns the value of attribute type.



62
63
64
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 62

def type
  @type
end

Class Method Details

._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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 348

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = MxPlatformRuby.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 65

def self.attribute_map
  {
    :'amount' => :'amount',
    :'categorized_by' => :'categorized_by',
    :'category' => :'category',
    :'category_guid' => :'category_guid',
    :'described_by' => :'described_by',
    :'description' => :'description',
    :'extended_transaction_type' => :'extended_transaction_type',
    :'id' => :'id',
    :'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',
    :'is_subscription' => :'is_subscription',
    :'memo' => :'memo',
    :'merchant_category_code' => :'merchant_category_code',
    :'merchant_guid' => :'merchant_guid',
    :'merchant_location_guid' => :'merchant_location_guid',
    :'original_description' => :'original_description',
    :'type' => :'type'
  }
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 324

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 128

def self.openapi_nullable
  Set.new([
    :'amount',
    :'categorized_by',
    :'category',
    :'category_guid',
    :'described_by',
    :'description',
    :'extended_transaction_type',
    :'id',
    :'is_bill_pay',
    :'is_direct_deposit',
    :'is_expense',
    :'is_fee',
    :'is_income',
    :'is_international',
    :'is_overdraft_fee',
    :'is_payroll_advance',
    :'is_subscription',
    :'memo',
    :'merchant_category_code',
    :'merchant_guid',
    :'merchant_location_guid',
    :'original_description',
    :'type'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 99

def self.openapi_types
  {
    :'amount' => :'Float',
    :'categorized_by' => :'Integer',
    :'category' => :'String',
    :'category_guid' => :'String',
    :'described_by' => :'Integer',
    :'description' => :'String',
    :'extended_transaction_type' => :'String',
    :'id' => :'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',
    :'is_subscription' => :'Boolean',
    :'memo' => :'String',
    :'merchant_category_code' => :'Integer',
    :'merchant_guid' => :'String',
    :'merchant_location_guid' => :'String',
    :'original_description' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      categorized_by == o.categorized_by &&
      category == o.category &&
      category_guid == o.category_guid &&
      described_by == o.described_by &&
      description == o.description &&
      extended_transaction_type == o.extended_transaction_type &&
      id == o.id &&
      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 &&
      is_subscription == o.is_subscription &&
      memo == o.memo &&
      merchant_category_code == o.merchant_category_code &&
      merchant_guid == o.merchant_guid &&
      merchant_location_guid == o.merchant_location_guid &&
      original_description == o.original_description &&
      type == o.type
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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 419

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


311
312
313
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



317
318
319
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 317

def hash
  [amount, categorized_by, category, category_guid, described_by, description, extended_transaction_type, id, is_bill_pay, is_direct_deposit, is_expense, is_fee, is_income, is_international, is_overdraft_fee, is_payroll_advance, is_subscription, memo, merchant_category_code, merchant_guid, merchant_location_guid, original_description, type].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



266
267
268
269
270
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 266

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



395
396
397
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 395

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



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 401

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



389
390
391
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 389

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



274
275
276
277
 
# File 'lib/mx-platform-ruby/models/enhance_transaction_response.rb', line 274

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end