Class: OpenapiClient::XHRVerticallyIntegratedApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ XHRVerticallyIntegratedApi

Returns a new instance of XHRVerticallyIntegratedApi.



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

def api_client
  @api_client
end

Instance Method Details

#xhr_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/xhr_vertically_integrated_api.rb', line 26

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



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/xhr_vertically_integrated_api.rb', line 35

def xhr_companies20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: XHRVerticallyIntegratedApi.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 => :"XHRVerticallyIntegratedApi.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: XHRVerticallyIntegratedApi#xhr_companies20230301\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

Options Hash (opts):

  • :employment_status (EmploymentStatusNotNullNotNullable) —

    Optional query parameter. Use to enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)

Returns:



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

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

Options Hash (opts):

  • :employment_status (EmploymentStatusNotNullNotNullable) —

    Optional query parameter. Use to enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)

Returns:

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

    Array<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
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 94

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'employment_status'] = opts[:'employment_status'] if !opts[:'employment_status'].nil?

  # 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 => :"XHRVerticallyIntegratedApi.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: XHRVerticallyIntegratedApi#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:



143
144
145
146
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 143

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



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

def xhr_groups20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: XHRVerticallyIntegratedApi.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 => :"XHRVerticallyIntegratedApi.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: XHRVerticallyIntegratedApi#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:



200
201
202
203
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 200

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



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
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 209

def xhr_identity20230301_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: XHRVerticallyIntegratedApi.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 => :"XHRVerticallyIntegratedApi.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: XHRVerticallyIntegratedApi#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: - brain payroll - brightpay connect - deel - gusto - justworks - moorepay - onpay - oyster - parolla.ie - paycircle - payfit - pento.io - quickbooks online - remote.com - sageone - shape payroll - simplepay.ie - staffology - xero uk

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:



259
260
261
262
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 259

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: - brain payroll - brightpay connect - deel - gusto - justworks - moorepay - onpay - oyster - parolla.ie - paycircle - payfit - pento.io - quickbooks online - remote.com - sageone - shape payroll - simplepay.ie - staffology - xero uk

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



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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 270

def xhr_payruns20230301_with_http_info(start_date, end_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: XHRVerticallyIntegratedApi.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 XHRVerticallyIntegratedApi.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 XHRVerticallyIntegratedApi.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 => :"XHRVerticallyIntegratedApi.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: XHRVerticallyIntegratedApi#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: - brain payroll - brightpay connect - deel - gusto - justworks - moorepay - onpay - oyster - parolla.ie - paycircle - payfit - pento.io - quickbooks online - remote.com - sageone - shape payroll - simplepay.ie - staffology - xero uk

Parameters:

  • payrun_id (String) —

    The id of the payrun.

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

    the optional parameters

Returns:



329
330
331
332
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 329

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: - brain payroll - brightpay connect - deel - gusto - justworks - moorepay - onpay - oyster - parolla.ie - paycircle - payfit - pento.io - quickbooks online - remote.com - sageone - shape payroll - simplepay.ie - staffology - xero uk

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



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

def xhr_payslips20230301_with_http_info(payrun_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: XHRVerticallyIntegratedApi.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 XHRVerticallyIntegratedApi.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 => :"XHRVerticallyIntegratedApi.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: XHRVerticallyIntegratedApi#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:



391
392
393
394
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 391

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



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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 400

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

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

Time off entries Retrieve time off / absence entries

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:



450
451
452
453
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 450

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

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

Time off entries Retrieve time off / absence entries

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<TimeOffEntryResponse>, Integer, Hash)>) —

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



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 461

def xhr_time_off_entries20230301_with_http_info(start_date, end_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: XHRVerticallyIntegratedApi.xhr_time_off_entries20230301 ...'
  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 XHRVerticallyIntegratedApi.xhr_time_off_entries20230301"
  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 XHRVerticallyIntegratedApi.xhr_time_off_entries20230301"
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/time-off-entries'

  # 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<TimeOffEntryResponse>'

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

  new_options = opts.merge(
    :operation => :"XHRVerticallyIntegratedApi.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: XHRVerticallyIntegratedApi#xhr_time_off_entries20230301\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Timesheets Retrieve Timesheets

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:



521
522
523
524
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 521

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

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

Timesheets Retrieve Timesheets

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<TimesheetResponse>, Integer, Hash)>) —

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



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
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
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 532

def xhr_timesheets20230301_with_http_info(start_date, end_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: XHRVerticallyIntegratedApi.xhr_timesheets20230301 ...'
  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 XHRVerticallyIntegratedApi.xhr_timesheets20230301"
  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 XHRVerticallyIntegratedApi.xhr_timesheets20230301"
  end
  # resource path
  local_var_path = '/2023-03-01/xhr/timesheets'

  # 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<TimesheetResponse>'

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

  new_options = opts.merge(
    :operation => :"XHRVerticallyIntegratedApi.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: XHRVerticallyIntegratedApi#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:



590
591
592
593
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 590

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



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
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
 
# File 'lib/openapi_client/api/xhr_vertically_integrated_api.rb', line 599

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