Class: Plaid::TransactionStream

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/transaction_stream.rb

Overview

A grouping of related transactions

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionStream

Initializes the object



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
 
# File 'lib/plaid/models/transaction_stream.rb', line 156

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account to which the stream belongs



20
21
22
 
# File 'lib/plaid/models/transaction_stream.rb', line 20

def 
  @account_id
end

#average_amount ⇒ Object

Returns the value of attribute average_amount.



51
52
53
 
# File 'lib/plaid/models/transaction_stream.rb', line 51

def average_amount
  @average_amount
end

#category ⇒ Object

A hierarchical array of the categories to which this transaction belongs. See [Categories](plaid.com/docs/api/products/transactions/#categoriesget). All implementations are encouraged to use the new ‘personal_finance_category` instead of `category`. `personal_finance_category` provides more meaningful categorization and greater accuracy.



26
27
28
 
# File 'lib/plaid/models/transaction_stream.rb', line 26

def category
  @category
end

#category_id ⇒ Object

The ID of the category to which this transaction belongs. See [Categories](plaid.com/docs/api/products/transactions/#categoriesget). All implementations are encouraged to use the new ‘personal_finance_category` instead of `category`. `personal_finance_category` provides more meaningful categorization and greater accuracy.



29
30
31
 
# File 'lib/plaid/models/transaction_stream.rb', line 29

def category_id
  @category_id
end

#description ⇒ Object

A description of the transaction stream.



32
33
34
 
# File 'lib/plaid/models/transaction_stream.rb', line 32

def description
  @description
end

#first_date ⇒ Object

The posted date of the earliest transaction in the stream.



38
39
40
 
# File 'lib/plaid/models/transaction_stream.rb', line 38

def first_date
  @first_date
end

#frequency ⇒ Object

Returns the value of attribute frequency.



46
47
48
 
# File 'lib/plaid/models/transaction_stream.rb', line 46

def frequency
  @frequency
end

#is_active ⇒ Object

Indicates whether the transaction stream is still live.



56
57
58
 
# File 'lib/plaid/models/transaction_stream.rb', line 56

def is_active
  @is_active
end

#is_user_modified ⇒ Object

As the ability to modify transactions streams has been discontinued, this field will always be ‘false`.



63
64
65
 
# File 'lib/plaid/models/transaction_stream.rb', line 63

def is_user_modified
  @is_user_modified
end

#last_amount ⇒ Object

Returns the value of attribute last_amount.



53
54
55
 
# File 'lib/plaid/models/transaction_stream.rb', line 53

def last_amount
  @last_amount
end

#last_date ⇒ Object

The posted date of the latest transaction in the stream.



41
42
43
 
# File 'lib/plaid/models/transaction_stream.rb', line 41

def last_date
  @last_date
end

#last_user_modified_datetime ⇒ Object

The date and time of the most recent user modification. This will only be set if ‘is_user_modified` is `true`.



66
67
68
 
# File 'lib/plaid/models/transaction_stream.rb', line 66

def last_user_modified_datetime
  @last_user_modified_datetime
end

#merchant_name ⇒ Object

The merchant associated with the transaction stream.



35
36
37
 
# File 'lib/plaid/models/transaction_stream.rb', line 35

def merchant_name
  @merchant_name
end

#personal_finance_category ⇒ Object

Returns the value of attribute personal_finance_category.



60
61
62
 
# File 'lib/plaid/models/transaction_stream.rb', line 60

def personal_finance_category
  @personal_finance_category
end

#predicted_next_date ⇒ Object

The predicted date of the next payment. This will only be set if the next payment date can be predicted.



44
45
46
 
# File 'lib/plaid/models/transaction_stream.rb', line 44

def predicted_next_date
  @predicted_next_date
end

#status ⇒ Object

Returns the value of attribute status.



58
59
60
 
# File 'lib/plaid/models/transaction_stream.rb', line 58

def status
  @status
end

#stream_id ⇒ Object

A unique id for the stream



23
24
25
 
# File 'lib/plaid/models/transaction_stream.rb', line 23

def stream_id
  @stream_id
end

#transaction_ids ⇒ Object

An array of Plaid transaction IDs belonging to the stream, sorted by posted date.



49
50
51
 
# File 'lib/plaid/models/transaction_stream.rb', line 49

def transaction_ids
  @transaction_ids
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



115
116
117
 
# File 'lib/plaid/models/transaction_stream.rb', line 115

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'stream_id' => :'stream_id',
    :'category' => :'category',
    :'category_id' => :'category_id',
    :'description' => :'description',
    :'merchant_name' => :'merchant_name',
    :'first_date' => :'first_date',
    :'last_date' => :'last_date',
    :'predicted_next_date' => :'predicted_next_date',
    :'frequency' => :'frequency',
    :'transaction_ids' => :'transaction_ids',
    :'average_amount' => :'average_amount',
    :'last_amount' => :'last_amount',
    :'is_active' => :'is_active',
    :'status' => :'status',
    :'personal_finance_category' => :'personal_finance_category',
    :'is_user_modified' => :'is_user_modified',
    :'last_user_modified_datetime' => :'last_user_modified_datetime'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



359
360
361
 
# File 'lib/plaid/models/transaction_stream.rb', line 359

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
148
149
150
151
152
 
# File 'lib/plaid/models/transaction_stream.rb', line 144

def self.openapi_nullable
  Set.new([
    :'category',
    :'category_id',
    :'merchant_name',
    :'predicted_next_date',
    :'personal_finance_category',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/plaid/models/transaction_stream.rb', line 120

def self.openapi_types
  {
    :'account_id' => :'String',
    :'stream_id' => :'String',
    :'category' => :'Array<String>',
    :'category_id' => :'String',
    :'description' => :'String',
    :'merchant_name' => :'String',
    :'first_date' => :'Date',
    :'last_date' => :'Date',
    :'predicted_next_date' => :'Date',
    :'frequency' => :'RecurringTransactionFrequency',
    :'transaction_ids' => :'Array<String>',
    :'average_amount' => :'TransactionStreamAmount',
    :'last_amount' => :'TransactionStreamAmount',
    :'is_active' => :'Boolean',
    :'status' => :'TransactionStreamStatus',
    :'personal_finance_category' => :'PersonalFinanceCategory',
    :'is_user_modified' => :'Boolean',
    :'last_user_modified_datetime' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/plaid/models/transaction_stream.rb', line 321

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      stream_id == o.stream_id &&
      category == o.category &&
      category_id == o.category_id &&
      description == o.description &&
      merchant_name == o.merchant_name &&
      first_date == o.first_date &&
      last_date == o.last_date &&
      predicted_next_date == o.predicted_next_date &&
      frequency == o.frequency &&
      transaction_ids == o.transaction_ids &&
      average_amount == o.average_amount &&
      last_amount == o.last_amount &&
      is_active == o.is_active &&
      status == o.status &&
      personal_finance_category == o.personal_finance_category &&
      is_user_modified == o.is_user_modified &&
      last_user_modified_datetime == o.last_user_modified_datetime
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/plaid/models/transaction_stream.rb', line 390

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 = Plaid.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



461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/plaid/models/transaction_stream.rb', line 461

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/plaid/models/transaction_stream.rb', line 366

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

See Also:

  • `==` method


346
347
348
 
# File 'lib/plaid/models/transaction_stream.rb', line 346

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



352
353
354
 
# File 'lib/plaid/models/transaction_stream.rb', line 352

def hash
  [, stream_id, category, category_id, description, merchant_name, first_date, last_date, predicted_next_date, frequency, transaction_ids, average_amount, last_amount, is_active, status, personal_finance_category, is_user_modified, last_user_modified_datetime].hash
end

#list_invalid_properties ⇒ Object

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



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
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/plaid/models/transaction_stream.rb', line 248

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

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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



437
438
439
 
# File 'lib/plaid/models/transaction_stream.rb', line 437

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/plaid/models/transaction_stream.rb', line 443

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



431
432
433
 
# File 'lib/plaid/models/transaction_stream.rb', line 431

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/plaid/models/transaction_stream.rb', line 303

def valid?
  return false if @account_id.nil?
  return false if @stream_id.nil?
  return false if @description.nil?
  return false if @first_date.nil?
  return false if @last_date.nil?
  return false if @frequency.nil?
  return false if @transaction_ids.nil?
  return false if @average_amount.nil?
  return false if @last_amount.nil?
  return false if @is_active.nil?
  return false if @status.nil?
  return false if @is_user_modified.nil?
  true
end