Class: Plaid::CreditBankIncomeSummary

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

Overview

Summary for bank income across all income sources and items (max history of 730 days).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreditBankIncomeSummary

Initializes the object



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 90

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

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

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

  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?(:'income_sources_count')
    self.income_sources_count = attributes[:'income_sources_count']
  end

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

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

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

Instance Attribute Details

#end_date ⇒ Object

The latest date in which all income sources identified by Plaid appear in the user’s account. The date will be returned in an ISO 8601 format (YYYY-MM-DD).



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

def end_date
  @end_date
end

#historical_summary ⇒ Object

Returns the value of attribute historical_summary.



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

def historical_summary
  @historical_summary
end

#income_categories_count ⇒ Object

Number of income categories per end user.



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

def income_categories_count
  @income_categories_count
end

#income_sources_count ⇒ Object

Number of income sources per end user.



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

def income_sources_count
  @income_sources_count
end

#income_transactions_count ⇒ Object

Number of income transactions per end user.



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

def income_transactions_count
  @income_transactions_count
end

#iso_currency_code ⇒ Object

The ISO 4217 currency code of the amount or balance.



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

def iso_currency_code
  @iso_currency_code
end

#start_date ⇒ Object

The earliest date within the days requested in which all income sources identified by Plaid appear in a user’s account. The date will be returned in an ISO 8601 format (YYYY-MM-DD).



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

def start_date
  @start_date
end

#total_amount ⇒ Object

Total amount of earnings across all the income sources in the end user’s Items for the days requested by the client.



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

def total_amount
  @total_amount
end

#unofficial_currency_code ⇒ Object

The unofficial currency code associated with the amount or balance. Always ‘null` if `iso_currency_code` is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.



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

def unofficial_currency_code
  @unofficial_currency_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 46

def self.attribute_map
  {
    :'total_amount' => :'total_amount',
    :'iso_currency_code' => :'iso_currency_code',
    :'unofficial_currency_code' => :'unofficial_currency_code',
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'income_sources_count' => :'income_sources_count',
    :'income_categories_count' => :'income_categories_count',
    :'income_transactions_count' => :'income_transactions_count',
    :'historical_summary' => :'historical_summary'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



186
187
188
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 186

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
85
86
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 81

def self.openapi_nullable
  Set.new([
    :'iso_currency_code',
    :'unofficial_currency_code',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 66

def self.openapi_types
  {
    :'total_amount' => :'Float',
    :'iso_currency_code' => :'String',
    :'unofficial_currency_code' => :'String',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'income_sources_count' => :'Integer',
    :'income_categories_count' => :'Integer',
    :'income_transactions_count' => :'Integer',
    :'historical_summary' => :'Array<CreditBankIncomeHistoricalSummary>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_amount == o.total_amount &&
      iso_currency_code == o.iso_currency_code &&
      unofficial_currency_code == o.unofficial_currency_code &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      income_sources_count == o.income_sources_count &&
      income_categories_count == o.income_categories_count &&
      income_transactions_count == o.income_transactions_count &&
      historical_summary == o.historical_summary
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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

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



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 287

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 193

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


173
174
175
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



179
180
181
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 179

def hash
  [total_amount, iso_currency_code, unofficial_currency_code, start_date, end_date, income_sources_count, income_categories_count, income_transactions_count, historical_summary].hash
end

#list_invalid_properties ⇒ Object

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



144
145
146
147
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 144

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



263
264
265
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 263

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 269

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



257
258
259
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 257

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



151
152
153
 
# File 'lib/plaid/models/credit_bank_income_summary.rb', line 151

def valid?
  true
end