Class: MergeHRISClient::PayrollRun

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_client/models/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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayrollRun

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 109

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

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

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

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

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

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

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

Instance Attribute Details

#check_date ⇒ Object

The day and time the payroll run was checked.



43
44
45
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 43

def check_date
  @check_date
end

#created_at ⇒ Object

The datetime that this object was created by Merge.



25
26
27
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 25

def created_at
  @created_at
end

#end_date ⇒ Object

The day and time the payroll run ended.



40
41
42
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 40

def end_date
  @end_date
end

#field_mappings ⇒ Object

Returns the value of attribute field_mappings.



48
49
50
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 48

def field_mappings
  @field_mappings
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 19

def id
  @id
end

#modified_at ⇒ Object

The datetime that this object was modified by Merge.



28
29
30
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 28

def modified_at
  @modified_at
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



50
51
52
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 50

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 22

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Object

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



46
47
48
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 46

def remote_was_deleted
  @remote_was_deleted
end

#run_state ⇒ Object

The state of the payroll run * ‘PAID` - PAID * `DRAFT` - DRAFT * `APPROVED` - APPROVED * `FAILED` - FAILED * `CLOSED` - CLOSED



31
32
33
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 31

def run_state
  @run_state
end

#run_type ⇒ Object

The type of the payroll run * ‘REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS



34
35
36
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 34

def run_type
  @run_type
end

#start_date ⇒ Object

The day and time the payroll run started.



37
38
39
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 37

def start_date
  @start_date
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 71

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 53

def self.attribute_map
  {
    :'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'
  }
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



220
221
222
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 220

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 94

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'run_state',
    :'run_type',
    :'start_date',
    :'end_date',
    :'check_date',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'created_at' => :'Time',
    :'modified_at' => :'Time',
    :'run_state' => :'RunStateEnum',
    :'run_type' => :'RunTypeEnum',
    :'start_date' => :'Time',
    :'end_date' => :'Time',
    :'check_date' => :'Time',
    :'remote_was_deleted' => :'Boolean',
    :'field_mappings' => :'Object',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      created_at == o.created_at &&
      modified_at == o.modified_at &&
      run_state == o.run_state &&
      run_type == o.run_type &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      check_date == o.check_date &&
      remote_was_deleted == o.remote_was_deleted &&
      field_mappings == o.field_mappings &&
      remote_data == o.remote_data
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



250
251
252
253
254
255
256
257
258
259
260
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
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 250

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeHRISClient.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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 321

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 227

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


207
208
209
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 213

def hash
  [id, remote_id, created_at, modified_at, run_state, run_type, start_date, end_date, check_date, remote_was_deleted, field_mappings, remote_data].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



175
176
177
178
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 175

def list_invalid_properties
  invalid_properties = Array.new
  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



297
298
299
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 297

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 303

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



291
292
293
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 291

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



182
183
184
 
# File 'lib/merge_hris_client/models/payroll_run.rb', line 182

def valid?
  true
end