Class: Plaid::CashflowReportMonthlySummary

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

Overview

Monthly summary statistics derived from transaction-level data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CashflowReportMonthlySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#average_daily_ending_balance ⇒ Object

Returns the value of attribute average_daily_ending_balance.



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

def average_daily_ending_balance
  @average_daily_ending_balance
end

#average_daily_inflow_amount ⇒ Object

Returns the value of attribute average_daily_inflow_amount.



31
32
33
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 31

def average_daily_inflow_amount
  @average_daily_inflow_amount
end

#average_daily_inflow_transaction_count ⇒ Object

The average count of the number of daily inflow transactions. Rounded to 2 decimal places.



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

def average_daily_inflow_transaction_count
  @average_daily_inflow_transaction_count
end

#average_daily_net_cashflow_amount ⇒ Object

Returns the value of attribute average_daily_net_cashflow_amount.



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

def average_daily_net_cashflow_amount
  @average_daily_net_cashflow_amount
end

#average_daily_outflow_amount ⇒ Object

Returns the value of attribute average_daily_outflow_amount.



33
34
35
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 33

def average_daily_outflow_amount
  @average_daily_outflow_amount
end

#average_daily_outflow_transaction_count ⇒ Object

The average count of the number of daily outflow transactions. Rounded to 2 decimal places.



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

def average_daily_outflow_transaction_count
  @average_daily_outflow_transaction_count
end

#end_date ⇒ Object

The end date of the period included in this monthly summary. This date will be the last day of the month, unless the month being covered is a partial month because it is the last month included in the summary and the date range being requested does not end with the last day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).



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

def end_date
  @end_date
end

#ending_balance ⇒ Object

Returns the value of attribute ending_balance.



27
28
29
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 27

def ending_balance
  @ending_balance
end

#negative_ending_balance_day_count ⇒ Object

The number of days with a negative daily average ending balance. The daily average is calculated across all valid accounts. Values will be in the range [0, 31].



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

def negative_ending_balance_day_count
  @negative_ending_balance_day_count
end

#nsf_transaction_count ⇒ Object

The total number of all NSF transactions during this month.



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

def nsf_transaction_count
  @nsf_transaction_count
end

#overdraft_transaction_count ⇒ Object

The total number of all overdraft transactions during this month.



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

def overdraft_transaction_count
  @overdraft_transaction_count
end

#start_date ⇒ Object

The start date of the period covered in this monthly summary. This date will be the first day of the month, unless the month being covered is a partial month because it is the first month included in the summary and the date range being requested does not begin with the first day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).



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

def start_date
  @start_date
end

#starting_balance ⇒ Object

Returns the value of attribute starting_balance.



25
26
27
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 25

def starting_balance
  @starting_balance
end

#total_loan_payment ⇒ Object

Returns the value of attribute total_loan_payment.



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

def total_loan_payment
  @total_loan_payment
end

#total_payroll ⇒ Object

Returns the value of attribute total_payroll.



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

def total_payroll
  @total_payroll
end

#total_revenue ⇒ Object

Returns the value of attribute total_revenue.



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

def total_revenue
  @total_revenue
end

#total_variable_expense ⇒ Object

Returns the value of attribute total_variable_expense.



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

def total_variable_expense
  @total_variable_expense
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 61

def self.attribute_map
  {
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'starting_balance' => :'starting_balance',
    :'ending_balance' => :'ending_balance',
    :'average_daily_ending_balance' => :'average_daily_ending_balance',
    :'average_daily_inflow_amount' => :'average_daily_inflow_amount',
    :'average_daily_outflow_amount' => :'average_daily_outflow_amount',
    :'average_daily_net_cashflow_amount' => :'average_daily_net_cashflow_amount',
    :'average_daily_inflow_transaction_count' => :'average_daily_inflow_transaction_count',
    :'average_daily_outflow_transaction_count' => :'average_daily_outflow_transaction_count',
    :'total_revenue' => :'total_revenue',
    :'total_loan_payment' => :'total_loan_payment',
    :'total_variable_expense' => :'total_variable_expense',
    :'total_payroll' => :'total_payroll',
    :'nsf_transaction_count' => :'nsf_transaction_count',
    :'overdraft_transaction_count' => :'overdraft_transaction_count',
    :'negative_ending_balance_day_count' => :'negative_ending_balance_day_count'
  }
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



330
331
332
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 330

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
116
117
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 112

def self.openapi_nullable
  Set.new([
    :'starting_balance',
    :'ending_balance',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'starting_balance' => :'CashflowReportMonthlySummaryStartingBalance',
    :'ending_balance' => :'CashflowReportMonthlySummaryEndingBalance',
    :'average_daily_ending_balance' => :'CashflowReportMonthlySummaryAverageDailyEndingBalance',
    :'average_daily_inflow_amount' => :'CashflowReportMonthlySummaryAverageDailyInflowAmount',
    :'average_daily_outflow_amount' => :'CashflowReportMonthlySummaryAverageDailyOutflowAmount',
    :'average_daily_net_cashflow_amount' => :'CashflowReportMonthlySummaryAverageDailyNetCashflowAmount',
    :'average_daily_inflow_transaction_count' => :'Float',
    :'average_daily_outflow_transaction_count' => :'Float',
    :'total_revenue' => :'CashflowReportMonthlySummaryTotalRevenue',
    :'total_loan_payment' => :'CashflowReportMonthlySummaryTotalLoanPayment',
    :'total_variable_expense' => :'CashflowReportMonthlySummaryTotalVariableExpense',
    :'total_payroll' => :'CashflowReportMonthlySummaryTotalPayroll',
    :'nsf_transaction_count' => :'Integer',
    :'overdraft_transaction_count' => :'Integer',
    :'negative_ending_balance_day_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 293

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      starting_balance == o.starting_balance &&
      ending_balance == o.ending_balance &&
      average_daily_ending_balance == o.average_daily_ending_balance &&
      average_daily_inflow_amount == o.average_daily_inflow_amount &&
      average_daily_outflow_amount == o.average_daily_outflow_amount &&
      average_daily_net_cashflow_amount == o.average_daily_net_cashflow_amount &&
      average_daily_inflow_transaction_count == o.average_daily_inflow_transaction_count &&
      average_daily_outflow_transaction_count == o.average_daily_outflow_transaction_count &&
      total_revenue == o.total_revenue &&
      total_loan_payment == o.total_loan_payment &&
      total_variable_expense == o.total_variable_expense &&
      total_payroll == o.total_payroll &&
      nsf_transaction_count == o.nsf_transaction_count &&
      overdraft_transaction_count == o.overdraft_transaction_count &&
      negative_ending_balance_day_count == o.negative_ending_balance_day_count
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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 361

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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 432

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 337

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


317
318
319
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 323

def hash
  [start_date, end_date, starting_balance, ending_balance, average_daily_ending_balance, average_daily_inflow_amount, average_daily_outflow_amount, average_daily_net_cashflow_amount, average_daily_inflow_transaction_count, average_daily_outflow_transaction_count, total_revenue, total_loan_payment, total_variable_expense, total_payroll, nsf_transaction_count, overdraft_transaction_count, negative_ending_balance_day_count].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



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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 205

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



408
409
410
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 408

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 414

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



402
403
404
 
# File 'lib/plaid/models/cashflow_report_monthly_summary.rb', line 402

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



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

def valid?
  return false if @start_date.nil?
  return false if @end_date.nil?
  return false if @average_daily_ending_balance.nil?
  return false if @average_daily_inflow_amount.nil?
  return false if @average_daily_outflow_amount.nil?
  return false if @average_daily_net_cashflow_amount.nil?
  return false if @average_daily_inflow_transaction_count.nil?
  return false if @average_daily_outflow_transaction_count.nil?
  return false if @total_revenue.nil?
  return false if @total_loan_payment.nil?
  return false if @total_variable_expense.nil?
  return false if @total_payroll.nil?
  return false if @nsf_transaction_count.nil?
  return false if @overdraft_transaction_count.nil?
  return false if @negative_ending_balance_day_count.nil?
  true
end