Class: Merge::Hris::PayrollRun

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

Overview

# The PayrollRun Object

### Description
The `PayrollRun` object is used to represent a group of pay statements for a
specific pay schedule.
### Usage Example
Fetch from the `LIST PayrollRuns` endpoint and filter by `ID` to show all
payroll runs.

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, run_state: OMIT, run_type: OMIT, start_date: OMIT, end_date: OMIT, check_date: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::PayrollRun

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.

  • run_state (Merge::Hris::RunStateEnum) (defaults to: OMIT) —

    The state of the payroll run

    • ‘PAID` - PAID

    • ‘DRAFT` - DRAFT

    • ‘APPROVED` - APPROVED

    • ‘FAILED` - FAILED

    • ‘CLOSED` - CLOSED

  • run_type (Merge::Hris::RunTypeEnum) (defaults to: OMIT) —

    The type of the payroll run

    • ‘REGULAR` - REGULAR

    • ‘OFF_CYCLE` - OFF_CYCLE

    • ‘CORRECTION` - CORRECTION

    • ‘TERMINATION` - TERMINATION

    • ‘SIGN_ON_BONUS` - SIGN_ON_BONUS

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

    The day and time the payroll run started.

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

    The day and time the payroll run ended.

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

    The day and time the payroll run was checked.

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

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • 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



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

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, run_state: OMIT, run_type: OMIT,
               start_date: OMIT, end_date: OMIT, check_date: 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
  @run_state = run_state if run_state != OMIT
  @run_type = run_type if run_type != OMIT
  @start_date = start_date if start_date != OMIT
  @end_date = end_date if end_date != OMIT
  @check_date = check_date if check_date != 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,
    "run_state": run_state,
    "run_type": run_type,
    "start_date": start_date,
    "end_date": end_date,
    "check_date": check_date,
    "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



58
59
60
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 58

def additional_properties
  @additional_properties
end

#check_date ⇒ DateTime (readonly)

Returns The day and time the payroll run was checked.

Returns:

  • (DateTime) —

    The day and time the payroll run was checked.



47
48
49
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 47

def check_date
  @check_date
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.



25
26
27
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 25

def created_at
  @created_at
end

#end_date ⇒ DateTime (readonly)

Returns The day and time the payroll run ended.

Returns:

  • (DateTime) —

    The day and time the payroll run ended.



45
46
47
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 45

def end_date
  @end_date
end

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

Returns:

  • (Hash{String => Object}) 


54
55
56
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 54

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


21
22
23
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 21

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.



27
28
29
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 27

def modified_at
  @modified_at
end

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

Returns:



56
57
58
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 56

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.



23
24
25
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 23

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. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



52
53
54
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 52

def remote_was_deleted
  @remote_was_deleted
end

#run_state ⇒ Merge::Hris::RunStateEnum (readonly)

Returns The state of the payroll run

  • ‘PAID` - PAID

  • ‘DRAFT` - DRAFT

  • ‘APPROVED` - APPROVED

  • ‘FAILED` - FAILED

  • ‘CLOSED` - CLOSED.

Returns:

  • (Merge::Hris::RunStateEnum) —

    The state of the payroll run

    • ‘PAID` - PAID

    • ‘DRAFT` - DRAFT

    • ‘APPROVED` - APPROVED

    • ‘FAILED` - FAILED

    • ‘CLOSED` - CLOSED



34
35
36
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 34

def run_state
  @run_state
end

#run_type ⇒ Merge::Hris::RunTypeEnum (readonly)

Returns The type of the payroll run

  • ‘REGULAR` - REGULAR

  • ‘OFF_CYCLE` - OFF_CYCLE

  • ‘CORRECTION` - CORRECTION

  • ‘TERMINATION` - TERMINATION

  • ‘SIGN_ON_BONUS` - SIGN_ON_BONUS.

Returns:

  • (Merge::Hris::RunTypeEnum) —

    The type of the payroll run

    • ‘REGULAR` - REGULAR

    • ‘OFF_CYCLE` - OFF_CYCLE

    • ‘CORRECTION` - CORRECTION

    • ‘TERMINATION` - TERMINATION

    • ‘SIGN_ON_BONUS` - SIGN_ON_BONUS



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

def run_type
  @run_type
end

#start_date ⇒ DateTime (readonly)

Returns The day and time the payroll run started.

Returns:

  • (DateTime) —

    The day and time the payroll run started.



43
44
45
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 43

def start_date
  @start_date
end

Class Method Details

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

Deserialize a JSON object to an instance of PayrollRun

Parameters:

  • json_object (String)

Returns:



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

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?)
  run_state = parsed_json["run_state"]
  run_type = parsed_json["run_type"]
  start_date = (DateTime.parse(parsed_json["start_date"]) unless parsed_json["start_date"].nil?)
  end_date = (DateTime.parse(parsed_json["end_date"]) unless parsed_json["end_date"].nil?)
  check_date = (DateTime.parse(parsed_json["check_date"]) unless parsed_json["check_date"].nil?)
  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,
    run_state: run_state,
    run_type: run_type,
    start_date: start_date,
    end_date: end_date,
    check_date: check_date,
    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) 


177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 177

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.run_state&.is_a?(Merge::Hris::RunStateEnum) != false || raise("Passed value for field obj.run_state is not the expected type, validation failed.")
  obj.run_type&.is_a?(Merge::Hris::RunTypeEnum) != false || raise("Passed value for field obj.run_type is not the expected type, validation failed.")
  obj.start_date&.is_a?(DateTime) != false || raise("Passed value for field obj.start_date is not the expected type, validation failed.")
  obj.end_date&.is_a?(DateTime) != false || raise("Passed value for field obj.end_date is not the expected type, validation failed.")
  obj.check_date&.is_a?(DateTime) != false || raise("Passed value for field obj.check_date 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 PayrollRun to a JSON object

Returns:

  • (String) 


167
168
169
 
# File 'lib/merge_ruby_client/hris/types/payroll_run.rb', line 167

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