Class: Plaid::Paystub

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

Overview

An object representing data extracted from the end user’s paystub.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Paystub

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
141
142
143
144
145
146
147
 
# File 'lib/plaid/models/paystub.rb', line 89

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#deductions ⇒ Object

Returns the value of attribute deductions.



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

def deductions
  @deductions
end

#doc_id ⇒ Object

An identifier of the document referenced by the document metadata.



22
23
24
 
# File 'lib/plaid/models/paystub.rb', line 22

def doc_id
  @doc_id
end

#earnings ⇒ Object

Returns the value of attribute earnings.



24
25
26
 
# File 'lib/plaid/models/paystub.rb', line 24

def earnings
  @earnings
end

#employee ⇒ Object

Returns the value of attribute employee.



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

def employee
  @employee
end

#employer ⇒ Object

Returns the value of attribute employer.



28
29
30
 
# File 'lib/plaid/models/paystub.rb', line 28

def employer
  @employer
end

#employment_details ⇒ Object

Returns the value of attribute employment_details.



30
31
32
 
# File 'lib/plaid/models/paystub.rb', line 30

def employment_details
  @employment_details
end

#income_breakdown ⇒ Object

Returns the value of attribute income_breakdown.



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

def income_breakdown
  @income_breakdown
end

#net_pay ⇒ Object

Returns the value of attribute net_pay.



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

def net_pay
  @net_pay
end

#pay_period_details ⇒ Object

Returns the value of attribute pay_period_details.



34
35
36
 
# File 'lib/plaid/models/paystub.rb', line 34

def pay_period_details
  @pay_period_details
end

#paystub_details ⇒ Object

Returns the value of attribute paystub_details.



36
37
38
 
# File 'lib/plaid/models/paystub.rb', line 36

def paystub_details
  @paystub_details
end

#ytd_earnings ⇒ Object

Returns the value of attribute ytd_earnings.



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

def ytd_earnings
  @ytd_earnings
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/plaid/models/paystub.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/plaid/models/paystub.rb', line 43

def self.attribute_map
  {
    :'deductions' => :'deductions',
    :'doc_id' => :'doc_id',
    :'earnings' => :'earnings',
    :'employee' => :'employee',
    :'employer' => :'employer',
    :'employment_details' => :'employment_details',
    :'net_pay' => :'net_pay',
    :'pay_period_details' => :'pay_period_details',
    :'paystub_details' => :'paystub_details',
    :'income_breakdown' => :'income_breakdown',
    :'ytd_earnings' => :'ytd_earnings'
  }
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



230
231
232
 
# File 'lib/plaid/models/paystub.rb', line 230

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/plaid/models/paystub.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'deductions' => :'Deductions',
    :'doc_id' => :'String',
    :'earnings' => :'Earnings',
    :'employee' => :'Employee',
    :'employer' => :'PaystubEmployer',
    :'employment_details' => :'EmploymentDetails',
    :'net_pay' => :'NetPay',
    :'pay_period_details' => :'PayPeriodDetails',
    :'paystub_details' => :'PaystubDetails',
    :'income_breakdown' => :'Array<IncomeBreakdown>',
    :'ytd_earnings' => :'PaystubYTDDetails'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/plaid/models/paystub.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      deductions == o.deductions &&
      doc_id == o.doc_id &&
      earnings == o.earnings &&
      employee == o.employee &&
      employer == o.employer &&
      employment_details == o.employment_details &&
      net_pay == o.net_pay &&
      pay_period_details == o.pay_period_details &&
      paystub_details == o.paystub_details &&
      income_breakdown == o.income_breakdown &&
      ytd_earnings == o.ytd_earnings
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



261
262
263
264
265
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
 
# File 'lib/plaid/models/paystub.rb', line 261

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/plaid/models/paystub.rb', line 332

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/plaid/models/paystub.rb', line 237

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


217
218
219
 
# File 'lib/plaid/models/paystub.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/plaid/models/paystub.rb', line 223

def hash
  [deductions, doc_id, earnings, employee, employer, employment_details, net_pay, pay_period_details, paystub_details, income_breakdown, ytd_earnings].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



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

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

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

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

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

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

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

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



308
309
310
 
# File 'lib/plaid/models/paystub.rb', line 308

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/plaid/models/paystub.rb', line 314

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



302
303
304
 
# File 'lib/plaid/models/paystub.rb', line 302

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



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/plaid/models/paystub.rb', line 186

def valid?
  return false if @deductions.nil?
  return false if @doc_id.nil?
  return false if @earnings.nil?
  return false if @employee.nil?
  return false if @employer.nil?
  return false if @net_pay.nil?
  return false if @pay_period_details.nil?
  true
end