Class: MergeHRISClient::TimeOff
- Inherits:
-
Object
- Object
- MergeHRISClient::TimeOff
- Defined in:
- lib/merge_hris_client/models/time_off.rb
Overview
# The TimeOff Object ### Description The ‘TimeOff` object is used to represent a Time Off Request filed by an employee. ### Usage Example Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.
Instance Attribute Summary collapse
-
#amount ⇒ Object
The number of time off units requested.
-
#approver ⇒ Object
The employee approving the time off request.
-
#employee ⇒ Object
The employee requesting time off.
-
#employee_note ⇒ Object
The employee note for this time off request.
-
#id ⇒ Object
Returns the value of attribute id.
-
#remote_data ⇒ Object
Returns the value of attribute remote_data.
-
#remote_id ⇒ Object
The third-party API ID of the matching object.
-
#request_type ⇒ Object
The type of time off request.
-
#status ⇒ Object
The status of this time off request.
-
#units ⇒ Object
The unit of time requested.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ TimeOff
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ TimeOff
Initializes the object
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 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 |
# File 'lib/merge_hris_client/models/time_off.rb', line 101 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?(:'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?(:'remote_data') if (value = attributes[:'remote_data']).is_a?(Array) self.remote_data = value end end end |
Instance Attribute Details
#amount ⇒ Object
The number of time off units requested.
40 41 42 |
# File 'lib/merge_hris_client/models/time_off.rb', line 40 def amount @amount end |
#approver ⇒ Object
The employee approving the time off request.
28 29 30 |
# File 'lib/merge_hris_client/models/time_off.rb', line 28 def approver @approver end |
#employee ⇒ Object
The employee requesting time off.
25 26 27 |
# File 'lib/merge_hris_client/models/time_off.rb', line 25 def employee @employee end |
#employee_note ⇒ Object
The employee note for this time off request.
34 35 36 |
# File 'lib/merge_hris_client/models/time_off.rb', line 34 def employee_note @employee_note 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 |
#remote_data ⇒ Object
Returns the value of attribute remote_data.
45 46 47 |
# File 'lib/merge_hris_client/models/time_off.rb', line 45 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 |
#request_type ⇒ Object
The type of time off request.
43 44 45 |
# File 'lib/merge_hris_client/models/time_off.rb', line 43 def request_type @request_type end |
#status ⇒ Object
The status of this time off request.
31 32 33 |
# File 'lib/merge_hris_client/models/time_off.rb', line 31 def status @status end |
#units ⇒ Object
The unit of time requested.
37 38 39 |
# File 'lib/merge_hris_client/models/time_off.rb', line 37 def units @units end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
64 65 66 |
# File 'lib/merge_hris_client/models/time_off.rb', line 64 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/merge_hris_client/models/time_off.rb', line 48 def self.attribute_map { :'id' => :'id', :'remote_id' => :'remote_id', :'employee' => :'employee', :'approver' => :'approver', :'status' => :'status', :'employee_note' => :'employee_note', :'units' => :'units', :'amount' => :'amount', :'request_type' => :'request_type', :'remote_data' => :'remote_data' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
202 203 204 |
# File 'lib/merge_hris_client/models/time_off.rb', line 202 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/merge_hris_client/models/time_off.rb', line 85 def self.openapi_nullable Set.new([ :'remote_id', :'employee', :'approver', :'status', :'employee_note', :'units', :'amount', :'request_type', :'remote_data' ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/merge_hris_client/models/time_off.rb', line 69 def self.openapi_types { :'id' => :'String', :'remote_id' => :'String', :'employee' => :'String', :'approver' => :'String', :'status' => :'TimeOffStatusEnum', :'employee_note' => :'String', :'units' => :'UnitsEnum', :'amount' => :'Float', :'request_type' => :'RequestTypeEnum', :'remote_data' => :'Array<RemoteData>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/merge_hris_client/models/time_off.rb', line 172 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && remote_id == o.remote_id && 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 && remote_data == o.remote_data end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/merge_hris_client/models/time_off.rb', line 232 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s 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
303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/merge_hris_client/models/time_off.rb', line 303 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
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/merge_hris_client/models/time_off.rb', line 209 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
189 190 191 |
# File 'lib/merge_hris_client/models/time_off.rb', line 189 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
195 196 197 |
# File 'lib/merge_hris_client/models/time_off.rb', line 195 def hash [id, remote_id, employee, approver, status, employee_note, units, amount, request_type, remote_data].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
159 160 161 162 |
# File 'lib/merge_hris_client/models/time_off.rb', line 159 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
279 280 281 |
# File 'lib/merge_hris_client/models/time_off.rb', line 279 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
285 286 287 288 289 290 291 292 293 294 295 296 297 |
# File 'lib/merge_hris_client/models/time_off.rb', line 285 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
273 274 275 |
# File 'lib/merge_hris_client/models/time_off.rb', line 273 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
166 167 168 |
# File 'lib/merge_hris_client/models/time_off.rb', line 166 def valid? true end |