Class: FuseClient::Transaction

Inherits:
Object
  • Object
show all
Defined in:
lib/fuse_client/models/transaction.rb

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
152
153
154
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
 
# File 'lib/fuse_client/models/transaction.rb', line 124

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FuseClient::Transaction` 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 `FuseClient::Transaction`. 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?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Amount in cents associated with the transaction. The format of this value is a double. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.



28
29
30
 
# File 'lib/fuse_client/models/transaction.rb', line 28

def amount
  @amount
end

#category ⇒ Object

Categories of the transaction, i.e., Computers and Electronics. You can download the categories from [here](fuse-public-bucket.s3.amazonaws.com/transaction-categories.csv)



37
38
39
 
# File 'lib/fuse_client/models/transaction.rb', line 37

def category
  @category
end

#date ⇒ Object

Date of the transaction (YYYY-MM-DD)



31
32
33
 
# File 'lib/fuse_client/models/transaction.rb', line 31

def date
  @date
end

#description ⇒ Object

Description of the transaction



34
35
36
 
# File 'lib/fuse_client/models/transaction.rb', line 34

def description
  @description
end

#fingerprint ⇒ Object

Uniquely identifies this transaction across all transactions for a single financial connection. Used for reconnection deduplication. This field may or may not be present depending on if a transaction can be uniquely identified. See more information here: letsfuse.readme.io/docs/duplicate-accounts



22
23
24
 
# File 'lib/fuse_client/models/transaction.rb', line 22

def fingerprint
  @fingerprint
end

#iso_currency_code ⇒ Object

The ISO-4217 currency code of the transaction



48
49
50
 
# File 'lib/fuse_client/models/transaction.rb', line 48

def iso_currency_code
  @iso_currency_code
end

#merchant ⇒ Object

Returns the value of attribute merchant.



39
40
41
 
# File 'lib/fuse_client/models/transaction.rb', line 39

def merchant
  @merchant
end

#remote_account_id ⇒ Object

Remote Account Id of the transaction, ie Plaid Account Id



25
26
27
 
# File 'lib/fuse_client/models/transaction.rb', line 25

def 
  @remote_account_id
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



50
51
52
 
# File 'lib/fuse_client/models/transaction.rb', line 50

def remote_data
  @remote_data
end

#remote_id ⇒ Object

Remote Id of the transaction, ie Plaid or Teller Id



19
20
21
 
# File 'lib/fuse_client/models/transaction.rb', line 19

def remote_id
  @remote_id
end

#status ⇒ Object

The status of the transaction. This will be either posted or pending.



42
43
44
 
# File 'lib/fuse_client/models/transaction.rb', line 42

def status
  @status
end

#type ⇒ Object

Type of the transaction, ie adjustment. ‘-’ means we were not able to map the upstream type.



45
46
47
 
# File 'lib/fuse_client/models/transaction.rb', line 45

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/fuse_client/models/transaction.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/fuse_client/models/transaction.rb', line 75

def self.attribute_map
  {
    :'remote_id' => :'remote_id',
    :'fingerprint' => :'fingerprint',
    :'remote_account_id' => :'remote_account_id',
    :'amount' => :'amount',
    :'date' => :'date',
    :'description' => :'description',
    :'category' => :'category',
    :'merchant' => :'merchant',
    :'status' => :'status',
    :'type' => :'type',
    :'iso_currency_code' => :'iso_currency_code',
    :'remote_data' => :'remote_data'
  }
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



304
305
306
 
# File 'lib/fuse_client/models/transaction.rb', line 304

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
120
 
# File 'lib/fuse_client/models/transaction.rb', line 116

def self.openapi_nullable
  Set.new([
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/fuse_client/models/transaction.rb', line 98

def self.openapi_types
  {
    :'remote_id' => :'String',
    :'fingerprint' => :'String',
    :'remote_account_id' => :'String',
    :'amount' => :'Float',
    :'date' => :'String',
    :'description' => :'String',
    :'category' => :'Array<String>',
    :'merchant' => :'TransactionMerchant',
    :'status' => :'String',
    :'type' => :'String',
    :'iso_currency_code' => :'String',
    :'remote_data' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/fuse_client/models/transaction.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      remote_id == o.remote_id &&
      fingerprint == o.fingerprint &&
       == o. &&
      amount == o.amount &&
      date == o.date &&
      description == o.description &&
      category == o.category &&
      merchant == o.merchant &&
      status == o.status &&
      type == o.type &&
      iso_currency_code == o.iso_currency_code &&
      remote_data == o.remote_data
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



335
336
337
338
339
340
341
342
343
344
345
346
347
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
 
# File 'lib/fuse_client/models/transaction.rb', line 335

def _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 = FuseClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/fuse_client/models/transaction.rb', line 406

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/fuse_client/models/transaction.rb', line 311

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


291
292
293
 
# File 'lib/fuse_client/models/transaction.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



297
298
299
 
# File 'lib/fuse_client/models/transaction.rb', line 297

def hash
  [remote_id, fingerprint, , amount, date, description, category, merchant, status, type, iso_currency_code, remote_data].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



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
 
# File 'lib/fuse_client/models/transaction.rb', line 190

def list_invalid_properties
  invalid_properties = Array.new
  if @remote_id.nil?
    invalid_properties.push('invalid value for "remote_id", remote_id cannot be nil.')
  end

  if @remote_account_id.nil?
    invalid_properties.push('invalid value for "remote_account_id", remote_account_id cannot be nil.')
  end

  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @date.nil?
    invalid_properties.push('invalid value for "date", date cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @category.nil?
    invalid_properties.push('invalid value for "category", category cannot be nil.')
  end

  if @merchant.nil?
    invalid_properties.push('invalid value for "merchant", merchant cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  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



382
383
384
 
# File 'lib/fuse_client/models/transaction.rb', line 382

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/fuse_client/models/transaction.rb', line 388

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



376
377
378
 
# File 'lib/fuse_client/models/transaction.rb', line 376

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/fuse_client/models/transaction.rb', line 233

def valid?
  return false if @remote_id.nil?
  return false if @remote_account_id.nil?
  return false if @amount.nil?
  return false if @date.nil?
  return false if @description.nil?
  return false if @category.nil?
  return false if @merchant.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["pending", "posted"])
  return false unless status_validator.valid?(@status)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["ach", "adjustment", "atm", "bank_charge", "bill_payment", "card_payment", "cash", "cashback", "charge", "cheque", "credit", "debit", "deposit", "digital_payment", "direct_debit", "fee", "in_store", "interest", "online", "other", "payment", "purchase", "standing_order", "transaction", "transfer", "wire", "withdrawal", "-"])
  return false unless type_validator.valid?(@type)
  true
end