Class: Plaid::BaseReportAttributes

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

Overview

Calculated attributes derived from transaction-level data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseReportAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/plaid/models/base_report_attributes.rb', line 116

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#is_primary_account ⇒ Object

Prediction indicator of whether the account is a primary account. Only one account per account type across the items connected will have a value of true.



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

def 
  @is_primary_account
end

#nsf_overdraft_transactions_count ⇒ Object

The number of NSF and overdraft fee transactions in the time range for the report in the given account.



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

def nsf_overdraft_transactions_count
  @nsf_overdraft_transactions_count
end

#nsf_overdraft_transactions_count_30d ⇒ Object

The number of NSF and overdraft fee transactions in the last 30 days for a given account.



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

def nsf_overdraft_transactions_count_30d
  @nsf_overdraft_transactions_count_30d
end

#nsf_overdraft_transactions_count_60d ⇒ Object

The number of NSF and overdraft fee transactions in the last 60 days for a given account.



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

def nsf_overdraft_transactions_count_60d
  @nsf_overdraft_transactions_count_60d
end

#nsf_overdraft_transactions_count_90d ⇒ Object

The number of NSF and overdraft fee transactions in the last 90 days for a given account.



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

def nsf_overdraft_transactions_count_90d
  @nsf_overdraft_transactions_count_90d
end

#primary_account_score ⇒ Object

Value ranging from 0-1. The higher the score, the more confident we are of the account being the primary account.



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

def 
  @primary_account_score
end

#total_inflow_amount ⇒ Object

Returns the value of attribute total_inflow_amount.



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

def total_inflow_amount
  @total_inflow_amount
end

#total_inflow_amount_30d ⇒ Object

Returns the value of attribute total_inflow_amount_30d.



39
40
41
 
# File 'lib/plaid/models/base_report_attributes.rb', line 39

def total_inflow_amount_30d
  @total_inflow_amount_30d
end

#total_inflow_amount_60d ⇒ Object

Returns the value of attribute total_inflow_amount_60d.



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

def total_inflow_amount_60d
  @total_inflow_amount_60d
end

#total_inflow_amount_90d ⇒ Object

Returns the value of attribute total_inflow_amount_90d.



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

def total_inflow_amount_90d
  @total_inflow_amount_90d
end

#total_outflow_amount ⇒ Object

Returns the value of attribute total_outflow_amount.



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

def total_outflow_amount
  @total_outflow_amount
end

#total_outflow_amount_30d ⇒ Object

Returns the value of attribute total_outflow_amount_30d.



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

def total_outflow_amount_30d
  @total_outflow_amount_30d
end

#total_outflow_amount_60d ⇒ Object

Returns the value of attribute total_outflow_amount_60d.



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

def total_outflow_amount_60d
  @total_outflow_amount_60d
end

#total_outflow_amount_90d ⇒ Object

Returns the value of attribute total_outflow_amount_90d.



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

def total_outflow_amount_90d
  @total_outflow_amount_90d
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/plaid/models/base_report_attributes.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/plaid/models/base_report_attributes.rb', line 54

def self.attribute_map
  {
    :'is_primary_account' => :'is_primary_account',
    :'primary_account_score' => :'primary_account_score',
    :'nsf_overdraft_transactions_count' => :'nsf_overdraft_transactions_count',
    :'nsf_overdraft_transactions_count_30d' => :'nsf_overdraft_transactions_count_30d',
    :'nsf_overdraft_transactions_count_60d' => :'nsf_overdraft_transactions_count_60d',
    :'nsf_overdraft_transactions_count_90d' => :'nsf_overdraft_transactions_count_90d',
    :'total_inflow_amount' => :'total_inflow_amount',
    :'total_inflow_amount_30d' => :'total_inflow_amount_30d',
    :'total_inflow_amount_60d' => :'total_inflow_amount_60d',
    :'total_inflow_amount_90d' => :'total_inflow_amount_90d',
    :'total_outflow_amount' => :'total_outflow_amount',
    :'total_outflow_amount_30d' => :'total_outflow_amount_30d',
    :'total_outflow_amount_60d' => :'total_outflow_amount_60d',
    :'total_outflow_amount_90d' => :'total_outflow_amount_90d'
  }
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



235
236
237
 
# File 'lib/plaid/models/base_report_attributes.rb', line 235

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'is_primary_account',
    :'primary_account_score',
    :'total_inflow_amount',
    :'total_inflow_amount_30d',
    :'total_inflow_amount_60d',
    :'total_inflow_amount_90d',
    :'total_outflow_amount',
    :'total_outflow_amount_30d',
    :'total_outflow_amount_60d',
    :'total_outflow_amount_90d'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/plaid/models/base_report_attributes.rb', line 79

def self.openapi_types
  {
    :'is_primary_account' => :'Boolean',
    :'primary_account_score' => :'Float',
    :'nsf_overdraft_transactions_count' => :'Integer',
    :'nsf_overdraft_transactions_count_30d' => :'Integer',
    :'nsf_overdraft_transactions_count_60d' => :'Integer',
    :'nsf_overdraft_transactions_count_90d' => :'Integer',
    :'total_inflow_amount' => :'TotalInflowAmount',
    :'total_inflow_amount_30d' => :'TotalInflowAmount30d',
    :'total_inflow_amount_60d' => :'TotalInflowAmount60d',
    :'total_inflow_amount_90d' => :'TotalInflowAmount90d',
    :'total_outflow_amount' => :'TotalOutflowAmount',
    :'total_outflow_amount_30d' => :'TotalOutflowAmount30d',
    :'total_outflow_amount_60d' => :'TotalOutflowAmount60d',
    :'total_outflow_amount_90d' => :'TotalOutflowAmount90d'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/plaid/models/base_report_attributes.rb', line 201

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      nsf_overdraft_transactions_count == o.nsf_overdraft_transactions_count &&
      nsf_overdraft_transactions_count_30d == o.nsf_overdraft_transactions_count_30d &&
      nsf_overdraft_transactions_count_60d == o.nsf_overdraft_transactions_count_60d &&
      nsf_overdraft_transactions_count_90d == o.nsf_overdraft_transactions_count_90d &&
      total_inflow_amount == o.total_inflow_amount &&
      total_inflow_amount_30d == o.total_inflow_amount_30d &&
      total_inflow_amount_60d == o.total_inflow_amount_60d &&
      total_inflow_amount_90d == o.total_inflow_amount_90d &&
      total_outflow_amount == o.total_outflow_amount &&
      total_outflow_amount_30d == o.total_outflow_amount_30d &&
      total_outflow_amount_60d == o.total_outflow_amount_60d &&
      total_outflow_amount_90d == o.total_outflow_amount_90d
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



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
300
301
302
303
 
# File 'lib/plaid/models/base_report_attributes.rb', line 266

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/plaid/models/base_report_attributes.rb', line 337

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/plaid/models/base_report_attributes.rb', line 242

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


222
223
224
 
# File 'lib/plaid/models/base_report_attributes.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



228
229
230
 
# File 'lib/plaid/models/base_report_attributes.rb', line 228

def hash
  [, , nsf_overdraft_transactions_count, nsf_overdraft_transactions_count_30d, nsf_overdraft_transactions_count_60d, nsf_overdraft_transactions_count_90d, total_inflow_amount, total_inflow_amount_30d, total_inflow_amount_60d, total_inflow_amount_90d, total_outflow_amount, total_outflow_amount_30d, total_outflow_amount_60d, total_outflow_amount_90d].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



188
189
190
191
 
# File 'lib/plaid/models/base_report_attributes.rb', line 188

def list_invalid_properties
  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



313
314
315
 
# File 'lib/plaid/models/base_report_attributes.rb', line 313

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/plaid/models/base_report_attributes.rb', line 319

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



307
308
309
 
# File 'lib/plaid/models/base_report_attributes.rb', line 307

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



195
196
197
 
# File 'lib/plaid/models/base_report_attributes.rb', line 195

def valid?
  true
end