Class: MergeHRISClient::TimeOffApi
- Inherits:
-
Object
- Object
- MergeHRISClient::TimeOffApi
- Defined in:
- lib/merge_hris_client/api/time_off_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ TimeOffApi
constructor
A new instance of TimeOffApi.
-
#time_off_create(x_account_token, time_off_endpoint_request, opts = {}) ⇒ TimeOffResponse
Creates a ‘TimeOff` object with the given values.
-
#time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts = {}) ⇒ Array<(TimeOffResponse, Integer, Hash)>
Creates a `TimeOff` object with the given values.
-
#time_off_list(x_account_token, opts = {}) ⇒ PaginatedTimeOffList
Returns a list of ‘TimeOff` objects.
-
#time_off_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedTimeOffList, Integer, Hash)>
Returns a list of `TimeOff` objects.
-
#time_off_meta_post_retrieve(x_account_token, opts = {}) ⇒ MetaResponse
Returns metadata for ‘TimeOff` POSTs.
-
#time_off_meta_post_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>
Returns metadata for `TimeOff` POSTs.
-
#time_off_retrieve(x_account_token, id, opts = {}) ⇒ TimeOff
Returns a ‘TimeOff` object with the given `id`.
-
#time_off_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(TimeOff, Integer, Hash)>
Returns a `TimeOff` object with the given `id`.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ TimeOffApi
Returns a new instance of TimeOffApi.
19 20 21 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#time_off_create(x_account_token, time_off_endpoint_request, opts = {}) ⇒ TimeOffResponse
Creates a ‘TimeOff` object with the given values.
29 30 31 32 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 29 def time_off_create(x_account_token, time_off_endpoint_request, opts = {}) data, _status_code, _headers = time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts) data end |
#time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts = {}) ⇒ Array<(TimeOffResponse, Integer, Hash)>
Creates a `TimeOff` object with the given values.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 41 def time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TimeOffApi.time_off_create ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TimeOffApi.time_off_create" end # verify the required parameter 'time_off_endpoint_request' is set if @api_client.config.client_side_validation && time_off_endpoint_request.nil? fail ArgumentError, "Missing the required parameter 'time_off_endpoint_request' when calling TimeOffApi.time_off_create" end # resource path local_var_path = '/time-off' # query parameters query_params = opts[:query_params] || {} query_params[:'is_debug_mode'] = opts[:'is_debug_mode'] if !opts[:'is_debug_mode'].nil? query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(time_off_endpoint_request) # return_type return_type = opts[:debug_return_type] || 'TimeOffResponse' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"TimeOffApi.time_off_create", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TimeOffApi#time_off_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#time_off_list(x_account_token, opts = {}) ⇒ PaginatedTimeOffList
Returns a list of ‘TimeOff` objects.
122 123 124 125 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 122 def time_off_list(x_account_token, opts = {}) data, _status_code, _headers = time_off_list_with_http_info(x_account_token, opts) data end |
#time_off_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedTimeOffList, Integer, Hash)>
Returns a list of `TimeOff` objects.
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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 151 def time_off_list_with_http_info(x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TimeOffApi.time_off_list ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TimeOffApi.time_off_list" end allowable_values = ["approver", "employee", "employee,approver"] if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand']) fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}" end allowable_values = ["request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units"] if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields']) fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}" end allowable_values = ["BEREAVEMENT", "JURY_DUTY", "PERSONAL", "SICK", "VACATION", "VOLUNTEER"] if @api_client.config.client_side_validation && opts[:'request_type'] && !allowable_values.include?(opts[:'request_type']) fail ArgumentError, "invalid value for \"request_type\", must be one of #{allowable_values}" end allowable_values = ["request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units"] if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins']) fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}" end allowable_values = ["APPROVED", "CANCELLED", "DECLINED", "DELETED", "REQUESTED"] if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status']) fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}" end # resource path local_var_path = '/time-off' # query parameters query_params = opts[:query_params] || {} query_params[:'approver_id'] = opts[:'approver_id'] if !opts[:'approver_id'].nil? query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil? query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil? query_params[:'ended_after'] = opts[:'ended_after'] if !opts[:'ended_after'].nil? query_params[:'ended_before'] = opts[:'ended_before'] if !opts[:'ended_before'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil? query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil? query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil? query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil? query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? query_params[:'request_type'] = opts[:'request_type'] if !opts[:'request_type'].nil? query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil? query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil? query_params[:'started_before'] = opts[:'started_before'] if !opts[:'started_before'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PaginatedTimeOffList' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"TimeOffApi.time_off_list", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TimeOffApi#time_off_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#time_off_meta_post_retrieve(x_account_token, opts = {}) ⇒ MetaResponse
Returns metadata for ‘TimeOff` POSTs.
244 245 246 247 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 244 def (x_account_token, opts = {}) data, _status_code, _headers = (x_account_token, opts) data end |
#time_off_meta_post_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>
Returns metadata for `TimeOff` POSTs.
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 288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 253 def (x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TimeOffApi.time_off_meta_post_retrieve ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TimeOffApi.time_off_meta_post_retrieve" end # resource path local_var_path = '/time-off/meta/post' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MetaResponse' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"TimeOffApi.time_off_meta_post_retrieve", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TimeOffApi#time_off_meta_post_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#time_off_retrieve(x_account_token, id, opts = {}) ⇒ TimeOff
Returns a ‘TimeOff` object with the given `id`.
311 312 313 314 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 311 def time_off_retrieve(x_account_token, id, opts = {}) data, _status_code, _headers = time_off_retrieve_with_http_info(x_account_token, id, opts) data end |
#time_off_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(TimeOff, Integer, Hash)>
Returns a `TimeOff` object with the given `id`.
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/merge_hris_client/api/time_off_api.rb', line 325 def time_off_retrieve_with_http_info(x_account_token, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TimeOffApi.time_off_retrieve ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling TimeOffApi.time_off_retrieve" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TimeOffApi.time_off_retrieve" end allowable_values = ["approver", "employee", "employee,approver"] if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand']) fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}" end allowable_values = ["request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units"] if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields']) fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}" end allowable_values = ["request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units"] if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins']) fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}" end # resource path local_var_path = '/time-off/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil? query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TimeOff' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"TimeOffApi.time_off_retrieve", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TimeOffApi#time_off_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |