Class: OpenapiClient::PayslipResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/payslip_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayslipResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
202
203
 
# File 'lib/openapi_client/models/payslip_response.rb', line 127

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#contributions ⇒ Object

Items paid by the employer that are not included in gross pay, such as employer-paid portion of private health insurance



45
46
47
 
# File 'lib/openapi_client/models/payslip_response.rb', line 45

def contributions
  @contributions
end

#currency ⇒ Object

Returns the value of attribute currency.



28
29
30
 
# File 'lib/openapi_client/models/payslip_response.rb', line 28

def currency
  @currency
end

#deductions ⇒ Object

Returns the value of attribute deductions.



47
48
49
 
# File 'lib/openapi_client/models/payslip_response.rb', line 47

def deductions
  @deductions
end

#earnings ⇒ Object

Returns the value of attribute earnings.



42
43
44
 
# File 'lib/openapi_client/models/payslip_response.rb', line 42

def earnings
  @earnings
end

#employee_id ⇒ Object

Returns the value of attribute employee_id.



24
25
26
 
# File 'lib/openapi_client/models/payslip_response.rb', line 24

def employee_id
  @employee_id
end

#end_date ⇒ Object

Returns the value of attribute end_date.



38
39
40
 
# File 'lib/openapi_client/models/payslip_response.rb', line 38

def end_date
  @end_date
end

#gross_pay ⇒ Object

if USD/EUR/GBP, in cent



31
32
33
 
# File 'lib/openapi_client/models/payslip_response.rb', line 31

def gross_pay
  @gross_pay
end

#id ⇒ Object

The Affix-assigned id of the payslip



19
20
21
 
# File 'lib/openapi_client/models/payslip_response.rb', line 19

def id
  @id
end

#net_pay ⇒ Object

if USD/EUR/GBP, in cent



34
35
36
 
# File 'lib/openapi_client/models/payslip_response.rb', line 34

def net_pay
  @net_pay
end

#payment_date ⇒ Object

Returns the value of attribute payment_date.



40
41
42
 
# File 'lib/openapi_client/models/payslip_response.rb', line 40

def payment_date
  @payment_date
end

#payrun_id ⇒ Object

Returns the value of attribute payrun_id.



26
27
28
 
# File 'lib/openapi_client/models/payslip_response.rb', line 26

def payrun_id
  @payrun_id
end

#remote_id ⇒ Object

the remote system-assigned id of the payrun



22
23
24
 
# File 'lib/openapi_client/models/payslip_response.rb', line 22

def remote_id
  @remote_id
end

#start_date ⇒ Object

Returns the value of attribute start_date.



36
37
38
 
# File 'lib/openapi_client/models/payslip_response.rb', line 36

def start_date
  @start_date
end

#taxes ⇒ Object

Returns the value of attribute taxes.



49
50
51
 
# File 'lib/openapi_client/models/payslip_response.rb', line 49

def taxes
  @taxes
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/openapi_client/models/payslip_response.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/openapi_client/models/payslip_response.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'employee_id' => :'employee_id',
    :'payrun_id' => :'payrun_id',
    :'currency' => :'currency',
    :'gross_pay' => :'gross_pay',
    :'net_pay' => :'net_pay',
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'payment_date' => :'payment_date',
    :'earnings' => :'earnings',
    :'contributions' => :'contributions',
    :'deductions' => :'deductions',
    :'taxes' => :'taxes'
  }
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



331
332
333
 
# File 'lib/openapi_client/models/payslip_response.rb', line 331

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
123
 
# File 'lib/openapi_client/models/payslip_response.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/openapi_client/models/payslip_response.rb', line 99

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'employee_id' => :'String',
    :'payrun_id' => :'String',
    :'currency' => :'String',
    :'gross_pay' => :'Float',
    :'net_pay' => :'Float',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'payment_date' => :'Date',
    :'earnings' => :'Array<PayslipResponseEarnings>',
    :'contributions' => :'Array<PayslipResponseContributions>',
    :'deductions' => :'Array<PayslipResponseDeductions>',
    :'taxes' => :'Array<PayslipResponseTaxes>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/openapi_client/models/payslip_response.rb', line 297

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      employee_id == o.employee_id &&
      payrun_id == o.payrun_id &&
      currency == o.currency &&
      gross_pay == o.gross_pay &&
      net_pay == o.net_pay &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      payment_date == o.payment_date &&
      earnings == o.earnings &&
      contributions == o.contributions &&
      deductions == o.deductions &&
      taxes == o.taxes
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/openapi_client/models/payslip_response.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 = OpenapiClient.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/openapi_client/models/payslip_response.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



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

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


318
319
320
 
# File 'lib/openapi_client/models/payslip_response.rb', line 318

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



324
325
326
 
# File 'lib/openapi_client/models/payslip_response.rb', line 324

def hash
  [id, remote_id, employee_id, payrun_id, currency, gross_pay, net_pay, start_date, end_date, payment_date, earnings, contributions, deductions, taxes].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



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
 
# File 'lib/openapi_client/models/payslip_response.rb', line 207

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

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

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

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

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

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

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

  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 @payment_date.nil?
    invalid_properties.push('invalid value for "payment_date", payment_date cannot be nil.')
  end

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

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

  if @taxes.nil?
    invalid_properties.push('invalid value for "taxes", taxes 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/openapi_client/models/payslip_response.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/openapi_client/models/payslip_response.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/openapi_client/models/payslip_response.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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/openapi_client/models/payslip_response.rb', line 266

def valid?
  return false if @id.nil?
  return false if @remote_id.nil?
  return false if @employee_id.nil?
  return false if @payrun_id.nil?
  return false if @currency.nil?
  currency_validator = EnumAttributeValidator.new('String', ["usd", "eur", "gbp"])
  return false unless currency_validator.valid?(@currency)
  return false if @gross_pay.nil?
  return false if @net_pay.nil?
  return false if @start_date.nil?
  return false if @end_date.nil?
  return false if @payment_date.nil?
  return false if @earnings.nil?
  return false if @deductions.nil?
  return false if @taxes.nil?
  true
end