Class: Merge::Hris::Tax

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/hris/types/tax.rb

Overview

# The Tax Object

### Description
The `Tax` object is used to represent an array of the tax deductions for a given
employee's payroll run.
### Usage Example
Fetch from the `LIST Taxes` endpoint and filter by `ID` to show all taxes.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee_payroll_run: OMIT, name: OMIT, amount: OMIT, employer_tax: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::Tax

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • employee_payroll_run (String) (defaults to: OMIT)
  • name (String) (defaults to: OMIT) —

    The tax’s name.

  • amount (Float) (defaults to: OMIT) —

    The tax amount.

  • employer_tax (Boolean) (defaults to: OMIT) —

    Whether or not the employer is responsible for paying the tax.

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform.

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Hris::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 62

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee_payroll_run: OMIT,
               name: OMIT, amount: OMIT, employer_tax: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @employee_payroll_run = employee_payroll_run if employee_payroll_run != OMIT
  @name = name if name != OMIT
  @amount = amount if amount != OMIT
  @employer_tax = employer_tax if employer_tax != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "employee_payroll_run": employee_payroll_run,
    "name": name,
    "amount": amount,
    "employer_tax": employer_tax,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.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



41
42
43
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 41

def additional_properties
  @additional_properties
end

#amount ⇒ Float (readonly)

Returns The tax amount.

Returns:

  • (Float) —

    The tax amount.



30
31
32
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 30

def amount
  @amount
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



22
23
24
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 22

def created_at
  @created_at
end

#employee_payroll_run ⇒ String (readonly)

Returns:

  • (String) 


26
27
28
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 26

def employee_payroll_run
  @employee_payroll_run
end

#employer_tax ⇒ Boolean (readonly)

Returns Whether or not the employer is responsible for paying the tax.

Returns:

  • (Boolean) —

    Whether or not the employer is responsible for paying the tax.



32
33
34
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 32

def employer_tax
  @employer_tax
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


37
38
39
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 37

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 18

def id
  @id
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



24
25
26
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 24

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns The tax’s name.

Returns:

  • (String) —

    The tax’s name.



28
29
30
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 28

def name
  @name
end

#remote_data ⇒ Array<Merge::Hris::RemoteData> (readonly)

Returns:



39
40
41
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 39

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



20
21
22
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 20

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform.

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform.



35
36
37
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 35

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Hris::Tax

Deserialize a JSON object to an instance of Tax

Parameters:

  • json_object (String)

Returns:



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
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 97

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  employee_payroll_run = parsed_json["employee_payroll_run"]
  name = parsed_json["name"]
  amount = parsed_json["amount"]
  employer_tax = parsed_json["employer_tax"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Hris::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    employee_payroll_run: employee_payroll_run,
    name: name,
    amount: amount,
    employer_tax: employer_tax,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 143

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.employee_payroll_run&.is_a?(String) != false || raise("Passed value for field obj.employee_payroll_run is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.amount&.is_a?(Float) != false || raise("Passed value for field obj.amount is not the expected type, validation failed.")
  obj.employer_tax&.is_a?(Boolean) != false || raise("Passed value for field obj.employer_tax is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of Tax to a JSON object

Returns:

  • (String) 


133
134
135
 
# File 'lib/merge_ruby_client/hris/types/tax.rb', line 133

def to_json(*_args)
  @_field_set&.to_json
end