Class: Gusto::Companies::ExternalPayrolls::ExternalPayrollsUpdateRequestExternalPayrollItemsItemEarningsItem

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb

Overview

earnings includes wages, hours, bonuses, tips, commission and more.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hours: OMIT, amount: OMIT, earning_id: OMIT, earning_type: OMIT, additional_properties: nil) ⇒ Gusto::Companies::ExternalPayrolls::ExternalPayrollsUpdateRequestExternalPayrollItemsItemEarningsItem

Parameters:



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb', line 34

def initialize(hours: OMIT, amount: OMIT, earning_id: OMIT, earning_type: OMIT, additional_properties: nil)
  @hours = hours if hours != OMIT
  @amount = amount if amount != OMIT
  @earning_id = earning_id if earning_id != OMIT
  @earning_type = earning_type if earning_type != OMIT
  @additional_properties = additional_properties
  @_field_set = { "hours": hours, "amount": amount, "earning_id": earning_id, "earning_type": earning_type }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



21
22
23
 
# File 'lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb', line 21

def additional_properties
  @additional_properties
end

#amount ⇒ String (readonly)

Returns The amount of the earning.

Returns:

  • (String) —

    The amount of the earning.



15
16
17
 
# File 'lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb', line 15

def amount
  @amount
end

#earning_id ⇒ Integer (readonly)

Returns The ID of the earning.

Returns:

  • (Integer) —

    The ID of the earning.



17
18
19
 
# File 'lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb', line 17

def earning_id
  @earning_id
end

#earning_type ⇒ Gusto::Companies::ExternalPayrolls::ExternalPayrollsUpdateRequestExternalPayrollItemsItemEarningsItemEarningType (readonly)

Returns The earning type for the compensation.

Returns:



19
20
21
 
# File 'lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb', line 19

def earning_type
  @earning_type
end

#hours ⇒ String (readonly)

Returns The hour of the compensation for the pay period.

Returns:

  • (String) —

    The hour of the compensation for the pay period.



13
14
15
 
# File 'lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb', line 13

def hours
  @hours
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::Companies::ExternalPayrolls::ExternalPayrollsUpdateRequestExternalPayrollItemsItemEarningsItem

Parameters:

  • json_object (String)

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb', line 49

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  hours = parsed_json["hours"]
  amount = parsed_json["amount"]
  earning_id = parsed_json["earning_id"]
  earning_type = parsed_json["earning_type"]
  new(
    hours: hours,
    amount: amount,
    earning_id: earning_id,
    earning_type: earning_type,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


78
79
80
81
82
83
 
# File 'lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb', line 78

def self.validate_raw(obj:)
  obj.hours&.is_a?(String) != false || raise("Passed value for field obj.hours is not the expected type, validation failed.")
  obj.amount&.is_a?(String) != false || raise("Passed value for field obj.amount is not the expected type, validation failed.")
  obj.earning_id&.is_a?(Integer) != false || raise("Passed value for field obj.earning_id is not the expected type, validation failed.")
  obj.earning_type&.is_a?(Gusto::Companies::ExternalPayrolls::ExternalPayrollsUpdateRequestExternalPayrollItemsItemEarningsItemEarningType) != false || raise("Passed value for field obj.earning_type is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


69
70
71
 
# File 'lib/fern_gusto/companies/external_payrolls/types/external_payrolls_update_request_external_payroll_items_item_earnings_item.rb', line 69

def to_json
  @_field_set&.to_json
end