Class: Plaid::RecurringInsightsStream

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

Overview

Insights object for recurring transactions streams.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecurringInsightsStream

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

  if attributes.key?(:'transaction_count')
    self.transaction_count = attributes[:'transaction_count']
  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?(:'newest_transaction_amount')
    self.newest_transaction_amount = attributes[:'newest_transaction_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_primary')
    self.personal_finance_category_primary = attributes[:'personal_finance_category_primary']
  end

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

Instance Attribute Details

#average_amount ⇒ Object

Returns the value of attribute average_amount.



45
46
47
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 45

def average_amount
  @average_amount
end

#average_days_apart ⇒ Object

The average number of days between each of the recurring transactions.



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

def average_days_apart
  @average_days_apart
end

#description ⇒ Object

The client-provided raw description of the most recent transaction in the stream.



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

def description
  @description
end

#frequency ⇒ Object

Returns the value of attribute frequency.



37
38
39
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 37

def frequency
  @frequency
end

#is_active ⇒ Object

Indicates whether the transaction stream is still live.



50
51
52
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 50

def is_active
  @is_active
end

#merchant_name ⇒ Object

The merchant or primary counterparty associated with the transaction stream.



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

def merchant_name
  @merchant_name
end

#newest_transaction_amount ⇒ Object

Returns the value of attribute newest_transaction_amount.



47
48
49
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 47

def newest_transaction_amount
  @newest_transaction_amount
end

#newest_transaction_date ⇒ Object

The posted date of the latest transaction in the stream.



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

def newest_transaction_date
  @newest_transaction_date
end

#oldest_transaction_date ⇒ Object

The posted date of the earliest transaction in the stream.



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

def oldest_transaction_date
  @oldest_transaction_date
end

#personal_finance_category_detailed ⇒ Object

The detailed category associated with the transaction stream.



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

def personal_finance_category_detailed
  @personal_finance_category_detailed
end

#personal_finance_category_primary ⇒ Object

The primary category associated with the transaction stream.



55
56
57
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 55

def personal_finance_category_primary
  @personal_finance_category_primary
end

#status ⇒ Object

Returns the value of attribute status.



52
53
54
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 52

def status
  @status
end

#stream_id ⇒ Object

A unique id for the stream.



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

def stream_id
  @stream_id
end

#transaction_count ⇒ Object

The number of transactions in this stream.



40
41
42
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 40

def transaction_count
  @transaction_count
end

#transaction_ids ⇒ Object

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



43
44
45
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 43

def transaction_ids
  @transaction_ids
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 104

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 83

def self.attribute_map
  {
    :'stream_id' => :'stream_id',
    :'description' => :'description',
    :'merchant_name' => :'merchant_name',
    :'oldest_transaction_date' => :'oldest_transaction_date',
    :'newest_transaction_date' => :'newest_transaction_date',
    :'average_days_apart' => :'average_days_apart',
    :'frequency' => :'frequency',
    :'transaction_count' => :'transaction_count',
    :'transaction_ids' => :'transaction_ids',
    :'average_amount' => :'average_amount',
    :'newest_transaction_amount' => :'newest_transaction_amount',
    :'is_active' => :'is_active',
    :'status' => :'status',
    :'personal_finance_category_primary' => :'personal_finance_category_primary',
    :'personal_finance_category_detailed' => :'personal_finance_category_detailed'
  }
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



283
284
285
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 283

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 130

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

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 109

def self.openapi_types
  {
    :'stream_id' => :'String',
    :'description' => :'String',
    :'merchant_name' => :'String',
    :'oldest_transaction_date' => :'Date',
    :'newest_transaction_date' => :'Date',
    :'average_days_apart' => :'Float',
    :'frequency' => :'RecurringTransactionFrequency',
    :'transaction_count' => :'Integer',
    :'transaction_ids' => :'Array<String>',
    :'average_amount' => :'TransactionStreamAmount',
    :'newest_transaction_amount' => :'TransactionStreamAmount',
    :'is_active' => :'Boolean',
    :'status' => :'TransactionStreamStatus',
    :'personal_finance_category_primary' => :'String',
    :'personal_finance_category_detailed' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      stream_id == o.stream_id &&
      description == o.description &&
      merchant_name == o.merchant_name &&
      oldest_transaction_date == o.oldest_transaction_date &&
      newest_transaction_date == o.newest_transaction_date &&
      average_days_apart == o.average_days_apart &&
      frequency == o.frequency &&
      transaction_count == o.transaction_count &&
      transaction_ids == o.transaction_ids &&
      average_amount == o.average_amount &&
      newest_transaction_amount == o.newest_transaction_amount &&
      is_active == o.is_active &&
      status == o.status &&
      personal_finance_category_primary == o.personal_finance_category_primary &&
      personal_finance_category_detailed == o.personal_finance_category_detailed
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



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
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 314

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 385

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 290

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


270
271
272
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 276

def hash
  [stream_id, description, merchant_name, oldest_transaction_date, newest_transaction_date, average_days_apart, frequency, transaction_count, transaction_ids, average_amount, newest_transaction_amount, is_active, status, personal_finance_category_primary, personal_finance_category_detailed].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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 215

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

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

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

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



361
362
363
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 367

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



355
356
357
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 355

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



238
239
240
241
242
243
244
 
# File 'lib/plaid/models/recurring_insights_stream.rb', line 238

def valid?
  return false if @stream_id.nil?
  return false if @merchant_name.nil?
  return false if @average_days_apart.nil?
  return false if @is_active.nil?
  true
end