Class: MergeHRISClient::TimeOffRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_client/models/time_off_request.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 = {}) ⇒ TimeOffRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
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
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 108

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

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

Instance Attribute Details

#amount ⇒ Object

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



35
36
37
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 35

def amount
  @amount
end

#approver ⇒ Object

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



23
24
25
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 23

def approver
  @approver
end

#employee ⇒ Object

The employee requesting time off.



20
21
22
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 20

def employee
  @employee
end

#employee_note ⇒ Object

The employee note for this time off request.



29
30
31
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 29

def employee_note
  @employee_note
end

#end_time ⇒ Object

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



44
45
46
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 44

def end_time
  @end_time
end

#integration_params ⇒ Object

Returns the value of attribute integration_params.



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

def integration_params
  @integration_params
end

#linked_account_params ⇒ Object

Returns the value of attribute linked_account_params.



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

def 
  @linked_account_params
end

#request_type ⇒ Object

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



38
39
40
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 38

def request_type
  @request_type
end

#start_time ⇒ Object

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



41
42
43
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 41

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



26
27
28
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 26

def status
  @status
end

#units ⇒ Object

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



32
33
34
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 32

def units
  @units
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 68

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 51

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



216
217
218
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 216

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 90

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 73

def self.openapi_types
  {
    :'employee' => :'String',
    :'approver' => :'String',
    :'status' => :'TimeOffStatusEnum',
    :'employee_note' => :'String',
    :'units' => :'UnitsEnum',
    :'amount' => :'Float',
    :'request_type' => :'RequestTypeEnum',
    :'start_time' => :'Time',
    :'end_time' => :'Time',
    :'integration_params' => :'Hash<String, Object>',
    :'linked_account_params' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      integration_params == o.integration_params &&
       == o.
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



246
247
248
249
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
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 246

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 317

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 223

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


203
204
205
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 209

def hash
  [employee, approver, status, employee_note, units, amount, request_type, start_time, end_time, integration_params, ].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



172
173
174
175
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 172

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



293
294
295
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 293

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 299

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



287
288
289
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 287

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



179
180
181
 
# File 'lib/merge_hris_client/models/time_off_request.rb', line 179

def valid?
  true
end