Class: Plaid::IncomeSummary

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

Overview

The verified fields from a paystub verification. All fields are provided as reported on the paystub.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IncomeSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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
 
# File 'lib/plaid/models/income_summary.rb', line 74

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

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

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

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

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

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

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

Instance Attribute Details

#employee_name ⇒ Object

Returns the value of attribute employee_name.



21
22
23
 
# File 'lib/plaid/models/income_summary.rb', line 21

def employee_name
  @employee_name
end

#employer_name ⇒ Object

Returns the value of attribute employer_name.



19
20
21
 
# File 'lib/plaid/models/income_summary.rb', line 19

def employer_name
  @employer_name
end

#pay_frequency ⇒ Object

Returns the value of attribute pay_frequency.



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

def pay_frequency
  @pay_frequency
end

#projected_wage ⇒ Object

Returns the value of attribute projected_wage.



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

def projected_wage
  @projected_wage
end

#verified_transaction ⇒ Object

Returns the value of attribute verified_transaction.



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

def verified_transaction
  @verified_transaction
end

#ytd_gross_income ⇒ Object

Returns the value of attribute ytd_gross_income.



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

def ytd_gross_income
  @ytd_gross_income
end

#ytd_net_income ⇒ Object

Returns the value of attribute ytd_net_income.



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

def ytd_net_income
  @ytd_net_income
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/plaid/models/income_summary.rb', line 34

def self.attribute_map
  {
    :'employer_name' => :'employer_name',
    :'employee_name' => :'employee_name',
    :'ytd_gross_income' => :'ytd_gross_income',
    :'ytd_net_income' => :'ytd_net_income',
    :'pay_frequency' => :'pay_frequency',
    :'projected_wage' => :'projected_wage',
    :'verified_transaction' => :'verified_transaction'
  }
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



183
184
185
 
# File 'lib/plaid/models/income_summary.rb', line 183

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



65
66
67
68
69
70
 
# File 'lib/plaid/models/income_summary.rb', line 65

def self.openapi_nullable
  Set.new([
    :'pay_frequency',
    :'verified_transaction'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/plaid/models/income_summary.rb', line 52

def self.openapi_types
  {
    :'employer_name' => :'EmployerIncomeSummaryFieldString',
    :'employee_name' => :'EmployeeIncomeSummaryFieldString',
    :'ytd_gross_income' => :'YTDGrossIncomeSummaryFieldNumber',
    :'ytd_net_income' => :'YTDNetIncomeSummaryFieldNumber',
    :'pay_frequency' => :'PayFrequency',
    :'projected_wage' => :'ProjectedIncomeSummaryFieldNumber',
    :'verified_transaction' => :'TransactionData'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/plaid/models/income_summary.rb', line 156

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      employer_name == o.employer_name &&
      employee_name == o.employee_name &&
      ytd_gross_income == o.ytd_gross_income &&
      ytd_net_income == o.ytd_net_income &&
      pay_frequency == o.pay_frequency &&
      projected_wage == o.projected_wage &&
      verified_transaction == o.verified_transaction
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



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

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/plaid/models/income_summary.rb', line 285

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/plaid/models/income_summary.rb', line 190

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


170
171
172
 
# File 'lib/plaid/models/income_summary.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



176
177
178
 
# File 'lib/plaid/models/income_summary.rb', line 176

def hash
  [employer_name, employee_name, ytd_gross_income, ytd_net_income, pay_frequency, projected_wage, verified_transaction].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



118
119
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/income_summary.rb', line 118

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

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

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

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

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



261
262
263
 
# File 'lib/plaid/models/income_summary.rb', line 261

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/plaid/models/income_summary.rb', line 267

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



255
256
257
 
# File 'lib/plaid/models/income_summary.rb', line 255

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



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

def valid?
  return false if @employer_name.nil?
  return false if @employee_name.nil?
  return false if @ytd_gross_income.nil?
  return false if @ytd_net_income.nil?
  return false if @projected_wage.nil?
  true
end