Class: FuseClient::TransactionToEnrich

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionToEnrich

Initializes the object

Parameters:

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

    Model attributes in the form of hash



107
108
109
110
111
112
113
114
115
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
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 107

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

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

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

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

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

  if attributes.key?(:'country_code')
    self.country_code = attributes[:'country_code']
  else
    self.country_code = 'US'
  end

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

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

  if attributes.key?(:'owner_type')
    self.owner_type = attributes[:'owner_type']
  else
    self.owner_type = 'consumer'
  end
end

Instance Attribute Details

#amount ⇒ Object

The amount of the transaction in cents, in the currency of the account. Must be a positive value. Use the type field to indicate the direction.



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

def amount
  @amount
end

#country_code ⇒ Object

Returns the value of attribute country_code.



33
34
35
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 33

def country_code
  @country_code
end

#date ⇒ Object

The date the transaction was posted.



38
39
40
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 38

def date
  @date
end

#description ⇒ Object

The name of the merchant if available or a description of the transaction.



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

def description
  @description
end

#direction ⇒ Object

The direction of the transaction.



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

def direction
  @direction
end

#id ⇒ Object

A unique ID for the transaction that to help you tie data back to your systems.



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

def id
  @id
end

#iso_currency_code ⇒ Object

Returns the value of attribute iso_currency_code.



35
36
37
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 35

def iso_currency_code
  @iso_currency_code
end

#mcc ⇒ Object

The merchant category code.



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

def mcc
  @mcc
end

#owner_type ⇒ Object

Returns the value of attribute owner_type.



40
41
42
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 40

def owner_type
  @owner_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 80

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

def self.attribute_map
  {
    :'id' => :'id',
    :'description' => :'description',
    :'mcc' => :'mcc',
    :'amount' => :'amount',
    :'direction' => :'direction',
    :'country_code' => :'country_code',
    :'iso_currency_code' => :'iso_currency_code',
    :'date' => :'date',
    :'owner_type' => :'owner_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



289
290
291
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 289

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 100

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 85

def self.openapi_types
  {
    :'id' => :'String',
    :'description' => :'String',
    :'mcc' => :'String',
    :'amount' => :'Float',
    :'direction' => :'String',
    :'country_code' => :'String',
    :'iso_currency_code' => :'String',
    :'date' => :'String',
    :'owner_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 260

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      description == o.description &&
      mcc == o.mcc &&
      amount == o.amount &&
      direction == o.direction &&
      country_code == o.country_code &&
      iso_currency_code == o.iso_currency_code &&
      date == o.date &&
      owner_type == o.owner_type
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 320

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 391

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 296

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


276
277
278
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



282
283
284
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 282

def hash
  [id, description, mcc, amount, direction, country_code, iso_currency_code, date, owner_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



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

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

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

  if @description.to_s.length < 1
    invalid_properties.push('invalid value for "description", the character length must be great than or equal to 1.')
  end

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

  if @amount < 0
    invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.')
  end

  if @direction.nil?
    invalid_properties.push('invalid value for "direction", direction 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



367
368
369
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 367

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 373

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



361
362
363
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 361

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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/fuse_client/models/transaction_to_enrich.rb', line 196

def valid?
  return false if @id.nil?
  return false if @description.nil?
  return false if @description.to_s.length < 1
  return false if @amount.nil?
  return false if @amount < 0
  return false if @direction.nil?
  direction_validator = EnumAttributeValidator.new('String', ["incoming", "outgoing"])
  return false unless direction_validator.valid?(@direction)
  owner_type_validator = EnumAttributeValidator.new('String', ["consumer", "business"])
  return false unless owner_type_validator.valid?(@owner_type)
  true
end