Class: OpenapiClient::Class20230301Api

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/class20230301_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Class20230301Api

Returns a new instance of Class20230301Api.



19
20
21
 
# File 'lib/openapi_client/api/class20230301_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/openapi_client/api/class20230301_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#official_companies20230301(opts = {}) ⇒ Array<CompanyResponse>

Company Retrieve company information

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 26

def official_companies20230301(opts = {})
  data, _status_code, _headers = official_companies20230301_with_http_info(opts)
  data
end

#official_companies20230301_with_http_info(opts = {}) ⇒ Array<(Array<CompanyResponse>, Integer, Hash)>

Company Retrieve company information

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<CompanyResponse>, Integer, Hash)>) —

    Array<CompanyResponse> data, response status code and response headers



35
36
37
38
39
40
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
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 35

def official_companies20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.official_companies20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/official/company'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<CompanyResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.official_companies20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#official_companies20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#official_create_employee20230301(create_employee_request, opts = {}) ⇒ EmployeeResponse

Create Employee Creates a new Employee

Parameters:

  • create_employee_request (CreateEmployeeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 84

def official_create_employee20230301(create_employee_request, opts = {})
  data, _status_code, _headers = official_create_employee20230301_with_http_info(create_employee_request, opts)
  data
end

#official_create_employee20230301_with_http_info(create_employee_request, opts = {}) ⇒ Array<(EmployeeResponse, Integer, Hash)>

Create Employee Creates a new Employee

Parameters:

  • create_employee_request (CreateEmployeeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmployeeResponse, Integer, Hash)>) —

    EmployeeResponse data, response status code and response headers



94
95
96
97
98
99
100
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
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 94

def official_create_employee20230301_with_http_info(create_employee_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.official_create_employee20230301 ...'
  end
  # verify the required parameter 'create_employee_request' is set
  if @api_client.config.client_side_validation && create_employee_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_employee_request' when calling Class20230301Api.official_create_employee20230301"
  end
  # resource path
  local_var_path = '/2023-03-01/official/employee'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_employee_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmployeeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.official_create_employee20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#official_create_employee20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#official_employees20230301(opts = {}) ⇒ Array<EmployeeResponse>

Employees List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software

Parameters:

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

    the optional parameters

Returns:



148
149
150
151
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 148

def official_employees20230301(opts = {})
  data, _status_code, _headers = official_employees20230301_with_http_info(opts)
  data
end

#official_employees20230301_with_http_info(opts = {}) ⇒ Array<(Array<EmployeeResponse>, Integer, Hash)>

Employees List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<EmployeeResponse>, Integer, Hash)>) —

    Array<EmployeeResponse> data, response status code and response headers



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
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 157

def official_employees20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.official_employees20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/official/employees'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<EmployeeResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.official_employees20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#official_employees20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#official_groups20230301(opts = {}) ⇒ Array<GroupResponse>

Groups The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.

Parameters:

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

    the optional parameters

Returns:



205
206
207
208
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 205

def official_groups20230301(opts = {})
  data, _status_code, _headers = official_groups20230301_with_http_info(opts)
  data
end

#official_groups20230301_with_http_info(opts = {}) ⇒ Array<(Array<GroupResponse>, Integer, Hash)>

Groups The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<GroupResponse>, Integer, Hash)>) —

    Array<GroupResponse> data, response status code and response headers



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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 214

def official_groups20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.official_groups20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/official/groups'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GroupResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.official_groups20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#official_groups20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#official_time_off_balances20230301(opts = {}) ⇒ Array<TimeOffBalanceResponse>

Time off balances Retrieve all time off balances.

Parameters:

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

    the optional parameters

Returns:



262
263
264
265
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 262

def official_time_off_balances20230301(opts = {})
  data, _status_code, _headers = official_time_off_balances20230301_with_http_info(opts)
  data
end

#official_time_off_balances20230301_with_http_info(opts = {}) ⇒ Array<(Array<TimeOffBalanceResponse>, Integer, Hash)>

Time off balances Retrieve all time off balances.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<TimeOffBalanceResponse>, Integer, Hash)>) —

    Array<TimeOffBalanceResponse> data, response status code and response headers



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
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 271

def official_time_off_balances20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.official_time_off_balances20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/official/time-off-balances'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TimeOffBalanceResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.official_time_off_balances20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#official_time_off_balances20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#official_time_off_entries20230301(opts = {}) ⇒ Array<TimeOffEntryResponse>

Time off entries Retrieve time off / absence entries

Parameters:

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

    the optional parameters

Returns:



319
320
321
322
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 319

def official_time_off_entries20230301(opts = {})
  data, _status_code, _headers = official_time_off_entries20230301_with_http_info(opts)
  data
end

#official_time_off_entries20230301_with_http_info(opts = {}) ⇒ Array<(Array<TimeOffEntryResponse>, Integer, Hash)>

Time off entries Retrieve time off / absence entries

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<TimeOffEntryResponse>, Integer, Hash)>) —

    Array<TimeOffEntryResponse> data, response status code and response headers



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
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 328

def official_time_off_entries20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.official_time_off_entries20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/official/time-off-entries'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TimeOffEntryResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.official_time_off_entries20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#official_time_off_entries20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#official_timesheets20230301(opts = {}) ⇒ Array<TimesheetResponse>

Timesheets Retrieve Timesheets

Parameters:

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

    the optional parameters

Returns:



376
377
378
379
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 376

def official_timesheets20230301(opts = {})
  data, _status_code, _headers = official_timesheets20230301_with_http_info(opts)
  data
end

#official_timesheets20230301_with_http_info(opts = {}) ⇒ Array<(Array<TimesheetResponse>, Integer, Hash)>

Timesheets Retrieve Timesheets

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<TimesheetResponse>, Integer, Hash)>) —

    Array<TimesheetResponse> data, response status code and response headers



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 385

def official_timesheets20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.official_timesheets20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/official/timesheets'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TimesheetResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.official_timesheets20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#official_timesheets20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#official_work_locations20230301(opts = {}) ⇒ Array<LocationResponse>

Work locations The Location object is used to represent an address that can be associated with an employee

Parameters:

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

    the optional parameters

Returns:



433
434
435
436
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 433

def official_work_locations20230301(opts = {})
  data, _status_code, _headers = official_work_locations20230301_with_http_info(opts)
  data
end

#official_work_locations20230301_with_http_info(opts = {}) ⇒ Array<(Array<LocationResponse>, Integer, Hash)>

Work locations The Location object is used to represent an address that can be associated with an employee

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<LocationResponse>, Integer, Hash)>) —

    Array<LocationResponse> data, response status code and response headers



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 442

def official_work_locations20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.official_work_locations20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/official/work-locations'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LocationResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.official_work_locations20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#official_work_locations20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#officialdentity20230301(opts = {}) ⇒ IdentityResponse

Identity List information of the user for the respective account

Parameters:

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

    the optional parameters

Returns:



490
491
492
493
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 490

def officialdentity20230301(opts = {})
  data, _status_code, _headers = officialdentity20230301_with_http_info(opts)
  data
end

#officialdentity20230301_with_http_info(opts = {}) ⇒ Array<(IdentityResponse, Integer, Hash)>

Identity List information of the user for the respective account

Parameters:

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

    the optional parameters

Returns:

  • (Array<(IdentityResponse, Integer, Hash)>) —

    IdentityResponse data, response status code and response headers



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 499

def officialdentity20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.officialdentity20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/official/identity'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.officialdentity20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#officialdentity20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_companies20230301(opts = {}) ⇒ Array<CompanyResponse>

Company Retrieve company information

Parameters:

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

    the optional parameters

Returns:



547
548
549
550
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 547

def xhr_companies20230301(opts = {})
  data, _status_code, _headers = xhr_companies20230301_with_http_info(opts)
  data
end

#xhr_companies20230301_with_http_info(opts = {}) ⇒ Array<(Array<CompanyResponse>, Integer, Hash)>

Company Retrieve company information

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<CompanyResponse>, Integer, Hash)>) —

    Array<CompanyResponse> data, response status code and response headers



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 556

def xhr_companies20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_companies20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/company'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<CompanyResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_companies20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_companies20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_create_employee20230301(create_employee_request, opts = {}) ⇒ EmployeeResponse

Create employee Creates a new Employee

Parameters:

  • create_employee_request (CreateEmployeeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



605
606
607
608
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 605

def xhr_create_employee20230301(create_employee_request, opts = {})
  data, _status_code, _headers = xhr_create_employee20230301_with_http_info(create_employee_request, opts)
  data
end

#xhr_create_employee20230301_with_http_info(create_employee_request, opts = {}) ⇒ Array<(EmployeeResponse, Integer, Hash)>

Create employee Creates a new Employee

Parameters:

  • create_employee_request (CreateEmployeeRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmployeeResponse, Integer, Hash)>) —

    EmployeeResponse data, response status code and response headers



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 615

def xhr_create_employee20230301_with_http_info(create_employee_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_create_employee20230301 ...'
  end
  # verify the required parameter 'create_employee_request' is set
  if @api_client.config.client_side_validation && create_employee_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_employee_request' when calling Class20230301Api.xhr_create_employee20230301"
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/employee'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_employee_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmployeeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_create_employee20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_create_employee20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_employees20230301(opts = {}) ⇒ Array<EmployeeResponse>

Employees List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software

Parameters:

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

    the optional parameters

Returns:



669
670
671
672
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 669

def xhr_employees20230301(opts = {})
  data, _status_code, _headers = xhr_employees20230301_with_http_info(opts)
  data
end

#xhr_employees20230301_with_http_info(opts = {}) ⇒ Array<(Array<EmployeeResponse>, Integer, Hash)>

Employees List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<EmployeeResponse>, Integer, Hash)>) —

    Array<EmployeeResponse> data, response status code and response headers



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 678

def xhr_employees20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_employees20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/employees'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<EmployeeResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_employees20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_employees20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_groups20230301(opts = {}) ⇒ Array<GroupResponse>

Groups The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.

Parameters:

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

    the optional parameters

Returns:



726
727
728
729
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 726

def xhr_groups20230301(opts = {})
  data, _status_code, _headers = xhr_groups20230301_with_http_info(opts)
  data
end

#xhr_groups20230301_with_http_info(opts = {}) ⇒ Array<(Array<GroupResponse>, Integer, Hash)>

Groups The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<GroupResponse>, Integer, Hash)>) —

    Array<GroupResponse> data, response status code and response headers



735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 735

def xhr_groups20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_groups20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/groups'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GroupResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_groups20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_groups20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_identity20230301(opts = {}) ⇒ IdentityResponse

Identity List information of the user for the respective account

Parameters:

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

    the optional parameters

Returns:



783
784
785
786
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 783

def xhr_identity20230301(opts = {})
  data, _status_code, _headers = xhr_identity20230301_with_http_info(opts)
  data
end

#xhr_identity20230301_with_http_info(opts = {}) ⇒ Array<(IdentityResponse, Integer, Hash)>

Identity List information of the user for the respective account

Parameters:

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

    the optional parameters

Returns:

  • (Array<(IdentityResponse, Integer, Hash)>) —

    IdentityResponse data, response status code and response headers



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 792

def xhr_identity20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_identity20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/identity'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_identity20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_identity20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_payruns20230301(start_date, end_date, opts = {}) ⇒ Array<PayrunResponse>

Payruns List all the pay runs that occurred during the respective period. Supported integrations: - sageone - simplepay.ie - brightpay connect

Parameters:

  • start_date (Date) —

    The start date of the search period

  • end_date (Date) —

    The end date of the search period

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

    the optional parameters

Returns:



842
843
844
845
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 842

def xhr_payruns20230301(start_date, end_date, opts = {})
  data, _status_code, _headers = xhr_payruns20230301_with_http_info(start_date, end_date, opts)
  data
end

#xhr_payruns20230301_with_http_info(start_date, end_date, opts = {}) ⇒ Array<(Array<PayrunResponse>, Integer, Hash)>

Payruns List all the pay runs that occurred during the respective period. Supported integrations: - sageone - simplepay.ie - brightpay connect

Parameters:

  • start_date (Date) —

    The start date of the search period

  • end_date (Date) —

    The end date of the search period

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

    the optional parameters

Returns:

  • (Array<(Array<PayrunResponse>, Integer, Hash)>) —

    Array<PayrunResponse> data, response status code and response headers



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 853

def xhr_payruns20230301_with_http_info(start_date, end_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_payruns20230301 ...'
  end
  # verify the required parameter 'start_date' is set
  if @api_client.config.client_side_validation && start_date.nil?
    fail ArgumentError, "Missing the required parameter 'start_date' when calling Class20230301Api.xhr_payruns20230301"
  end
  # verify the required parameter 'end_date' is set
  if @api_client.config.client_side_validation && end_date.nil?
    fail ArgumentError, "Missing the required parameter 'end_date' when calling Class20230301Api.xhr_payruns20230301"
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/payruns'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start_date'] = start_date
  query_params[:'end_date'] = end_date

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PayrunResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_payruns20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_payruns20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_payslips20230301(payrun_id, opts = {}) ⇒ Array<PayslipResponse>

Payslips Retrieves payslips from a specific payrun. Supported integrations: - sageone - simplepay.ie - brightpay connect

Parameters:

  • payrun_id (String) —

    The id of the payrun.

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

    the optional parameters

Returns:



912
913
914
915
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 912

def xhr_payslips20230301(payrun_id, opts = {})
  data, _status_code, _headers = xhr_payslips20230301_with_http_info(payrun_id, opts)
  data
end

#xhr_payslips20230301_with_http_info(payrun_id, opts = {}) ⇒ Array<(Array<PayslipResponse>, Integer, Hash)>

Payslips Retrieves payslips from a specific payrun. Supported integrations: - sageone - simplepay.ie - brightpay connect

Parameters:

  • payrun_id (String) —

    The id of the payrun.

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

    the optional parameters

Returns:

  • (Array<(Array<PayslipResponse>, Integer, Hash)>) —

    Array<PayslipResponse> data, response status code and response headers



922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 922

def xhr_payslips20230301_with_http_info(payrun_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_payslips20230301 ...'
  end
  # verify the required parameter 'payrun_id' is set
  if @api_client.config.client_side_validation && payrun_id.nil?
    fail ArgumentError, "Missing the required parameter 'payrun_id' when calling Class20230301Api.xhr_payslips20230301"
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/payruns/{payrun_id}'.sub('{' + 'payrun_id' + '}', CGI.escape(payrun_id.to_s))

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PayslipResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_payslips20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_payslips20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_time_off_balances20230301(opts = {}) ⇒ Array<TimeOffBalanceResponse>

Time off balances Retrieve all time off balances.

Parameters:

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

    the optional parameters

Returns:



974
975
976
977
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 974

def xhr_time_off_balances20230301(opts = {})
  data, _status_code, _headers = xhr_time_off_balances20230301_with_http_info(opts)
  data
end

#xhr_time_off_balances20230301_with_http_info(opts = {}) ⇒ Array<(Array<TimeOffBalanceResponse>, Integer, Hash)>

Time off balances Retrieve all time off balances.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<TimeOffBalanceResponse>, Integer, Hash)>) —

    Array<TimeOffBalanceResponse> data, response status code and response headers



983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 983

def xhr_time_off_balances20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_time_off_balances20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/time-off-balances'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TimeOffBalanceResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_time_off_balances20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_time_off_balances20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_time_off_entries20230301(opts = {}) ⇒ Array<TimeOffEntryResponse>

Time off entries Retrieve time off / absence entries

Parameters:

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

    the optional parameters

Returns:



1031
1032
1033
1034
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 1031

def xhr_time_off_entries20230301(opts = {})
  data, _status_code, _headers = xhr_time_off_entries20230301_with_http_info(opts)
  data
end

#xhr_time_off_entries20230301_with_http_info(opts = {}) ⇒ Array<(Array<TimeOffEntryResponse>, Integer, Hash)>

Time off entries Retrieve time off / absence entries

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<TimeOffEntryResponse>, Integer, Hash)>) —

    Array<TimeOffEntryResponse> data, response status code and response headers



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 1040

def xhr_time_off_entries20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_time_off_entries20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/time-off-entries'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TimeOffEntryResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_time_off_entries20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_time_off_entries20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_timesheets20230301(opts = {}) ⇒ Array<TimesheetResponse>

Timesheets Retrieve Timesheets

Parameters:

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

    the optional parameters

Returns:



1088
1089
1090
1091
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 1088

def xhr_timesheets20230301(opts = {})
  data, _status_code, _headers = xhr_timesheets20230301_with_http_info(opts)
  data
end

#xhr_timesheets20230301_with_http_info(opts = {}) ⇒ Array<(Array<TimesheetResponse>, Integer, Hash)>

Timesheets Retrieve Timesheets

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<TimesheetResponse>, Integer, Hash)>) —

    Array<TimesheetResponse> data, response status code and response headers



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 1097

def xhr_timesheets20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_timesheets20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/timesheets'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TimesheetResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_timesheets20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_timesheets20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#xhr_work_locations20230301(opts = {}) ⇒ Array<LocationResponse>

Work locations The Location object is used to represent an address that can be associated with an employee

Parameters:

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

    the optional parameters

Returns:



1145
1146
1147
1148
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 1145

def xhr_work_locations20230301(opts = {})
  data, _status_code, _headers = xhr_work_locations20230301_with_http_info(opts)
  data
end

#xhr_work_locations20230301_with_http_info(opts = {}) ⇒ Array<(Array<LocationResponse>, Integer, Hash)>

Work locations The Location object is used to represent an address that can be associated with an employee

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<LocationResponse>, Integer, Hash)>) —

    Array<LocationResponse> data, response status code and response headers



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/openapi_client/api/class20230301_api.rb', line 1154

def xhr_work_locations20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Class20230301Api.xhr_work_locations20230301 ...'
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/work-locations'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LocationResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['access-token']

  new_options = opts.merge(
    :operation => :"Class20230301Api.xhr_work_locations20230301",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Class20230301Api#xhr_work_locations20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end