Class: OpenapiClient::OfficialApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OfficialApi

Returns a new instance of OfficialApi.



19
20
21
 
# File 'lib/openapi_client/api/official_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/official_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/official_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/official_api.rb', line 35

def official_companies20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OfficialApi.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 => :"OfficialApi.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: OfficialApi#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/official_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/official_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: OfficialApi.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 OfficialApi.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 => :"OfficialApi.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: OfficialApi#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/official_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/official_api.rb', line 157

def official_employees20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OfficialApi.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 => :"OfficialApi.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: OfficialApi#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/official_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/official_api.rb', line 214

def official_groups20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OfficialApi.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 => :"OfficialApi.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: OfficialApi#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/official_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/official_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: OfficialApi.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 => :"OfficialApi.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: OfficialApi#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/official_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/official_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: OfficialApi.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 => :"OfficialApi.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: OfficialApi#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/official_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/official_api.rb', line 385

def official_timesheets20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OfficialApi.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 => :"OfficialApi.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: OfficialApi#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/official_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/official_api.rb', line 442

def official_work_locations20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OfficialApi.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 => :"OfficialApi.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: OfficialApi#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/official_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/official_api.rb', line 499

def officialdentity20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OfficialApi.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 => :"OfficialApi.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: OfficialApi#officialdentity20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end