Class: MergeHRISClient::TimeOff

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_client/models/time_off.rb

Overview

# The TimeOff Object ### Description The ‘TimeOff` object is used to represent all employees’ Time Off entries. ### Usage Example Fetch from the ‘LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimeOff

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
204
205
206
207
208
209
210
 
# File 'lib/merge_hris_client/models/time_off.rb', line 132

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

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

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

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

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

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

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

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

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

#amount ⇒ Object

The time off quantity measured by the prescribed “units”.



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

def amount
  @amount
end

#approver ⇒ Object

The Merge ID of the employee with the ability to approve the time off request.



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

def approver
  @approver
end

#created_at ⇒ Object

The datetime that this object was created by Merge.



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

def created_at
  @created_at
end

#employee ⇒ Object

The employee requesting time off.



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

def employee
  @employee
end

#employee_note ⇒ Object

The employee note for this time off request.



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

def employee_note
  @employee_note
end

#end_time ⇒ Object

The day and time of the end of the time requested off.



55
56
57
 
# File 'lib/merge_hris_client/models/time_off.rb', line 55

def end_time
  @end_time
end

#field_mappings ⇒ Object

Returns the value of attribute field_mappings.



59
60
61
 
# File 'lib/merge_hris_client/models/time_off.rb', line 59

def field_mappings
  @field_mappings
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_hris_client/models/time_off.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/time_off.rb', line 28

def modified_at
  @modified_at
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



61
62
63
 
# File 'lib/merge_hris_client/models/time_off.rb', line 61

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/time_off.rb', line 22

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Object

Returns the value of attribute remote_was_deleted.



57
58
59
 
# File 'lib/merge_hris_client/models/time_off.rb', line 57

def remote_was_deleted
  @remote_was_deleted
end

#request_type ⇒ Object

The type of time off request. * ‘VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT



49
50
51
 
# File 'lib/merge_hris_client/models/time_off.rb', line 49

def request_type
  @request_type
end

#start_time ⇒ Object

The day and time of the start of the time requested off.



52
53
54
 
# File 'lib/merge_hris_client/models/time_off.rb', line 52

def start_time
  @start_time
end

#status ⇒ Object

The status of this time off request. * ‘REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED



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

def status
  @status
end

#units ⇒ Object

The measurement that the third-party integration uses to count time requested. * ‘HOURS` - HOURS * `DAYS` - DAYS



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

def units
  @units
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/merge_hris_client/models/time_off.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/merge_hris_client/models/time_off.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'created_at' => :'created_at',
    :'modified_at' => :'modified_at',
    :'employee' => :'employee',
    :'approver' => :'approver',
    :'status' => :'status',
    :'employee_note' => :'employee_note',
    :'units' => :'units',
    :'amount' => :'amount',
    :'request_type' => :'request_type',
    :'start_time' => :'start_time',
    :'end_time' => :'end_time',
    :'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



263
264
265
 
# File 'lib/merge_hris_client/models/time_off.rb', line 263

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/merge_hris_client/models/time_off.rb', line 113

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'employee',
    :'approver',
    :'status',
    :'employee_note',
    :'units',
    :'amount',
    :'request_type',
    :'start_time',
    :'end_time',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/merge_hris_client/models/time_off.rb', line 91

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'created_at' => :'Time',
    :'modified_at' => :'Time',
    :'employee' => :'String',
    :'approver' => :'String',
    :'status' => :'TimeOffStatusEnum',
    :'employee_note' => :'String',
    :'units' => :'UnitsEnum',
    :'amount' => :'Float',
    :'request_type' => :'RequestTypeEnum',
    :'start_time' => :'Time',
    :'end_time' => :'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



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

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 &&
      employee == o.employee &&
      approver == o.approver &&
      status == o.status &&
      employee_note == o.employee_note &&
      units == o.units &&
      amount == o.amount &&
      request_type == o.request_type &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/merge_hris_client/models/time_off.rb', line 293

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/merge_hris_client/models/time_off.rb', line 364

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/merge_hris_client/models/time_off.rb', line 270

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


250
251
252
 
# File 'lib/merge_hris_client/models/time_off.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



256
257
258
 
# File 'lib/merge_hris_client/models/time_off.rb', line 256

def hash
  [id, remote_id, created_at, modified_at, employee, approver, status, employee_note, units, amount, request_type, start_time, end_time, 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



214
215
216
217
 
# File 'lib/merge_hris_client/models/time_off.rb', line 214

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



340
341
342
 
# File 'lib/merge_hris_client/models/time_off.rb', line 340

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/merge_hris_client/models/time_off.rb', line 346

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



334
335
336
 
# File 'lib/merge_hris_client/models/time_off.rb', line 334

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



221
222
223
 
# File 'lib/merge_hris_client/models/time_off.rb', line 221

def valid?
  true
end