Class: StackOneHRIS::EmployeesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/stackone_hris_client/api/employees_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmployeesApi

Returns a new instance of EmployeesApi.



19
20
21
 
# File 'lib/stackone_hris_client/api/employees_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/stackone_hris_client/api/employees_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#employee_create(x_account_id, hris_create_employee_request_dto, opts = {}) ⇒ CreateEmployeeResult

Creates an employee

Parameters:

  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 27

def employee_create(, hris_create_employee_request_dto, opts = {})
  data, _status_code, _headers = employee_create_with_http_info(, hris_create_employee_request_dto, opts)
  data
end

#employee_create_with_http_info(x_account_id, hris_create_employee_request_dto, opts = {}) ⇒ Array<(CreateEmployeeResult, Integer, Hash)>

Creates an employee

Parameters:

  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Returns:

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

    CreateEmployeeResult data, response status code and response headers



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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 37

def employee_create_with_http_info(, hris_create_employee_request_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeesApi.employee_create ...'
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling EmployeesApi.employee_create"
  end
  # verify the required parameter 'hris_create_employee_request_dto' is set
  if @api_client.config.client_side_validation && hris_create_employee_request_dto.nil?
    fail ArgumentError, "Missing the required parameter 'hris_create_employee_request_dto' when calling EmployeesApi.employee_create"
  end
  # resource path
  local_var_path = '/unified/hris/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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'x-account-id'] = 

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic']

  new_options = opts.merge(
    :operation => :"EmployeesApi.employee_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeesApi#employee_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#employee_replace(id, x_account_id, hris_create_employee_request_dto, opts = {}) ⇒ CreateEmployeeResult

Replaces an employee

Parameters:

  • id (String)
  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Returns:



101
102
103
104
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 101

def employee_replace(id, , hris_create_employee_request_dto, opts = {})
  data, _status_code, _headers = employee_replace_with_http_info(id, , hris_create_employee_request_dto, opts)
  data
end

#employee_replace_with_http_info(id, x_account_id, hris_create_employee_request_dto, opts = {}) ⇒ Array<(CreateEmployeeResult, Integer, Hash)>

Replaces an employee

Parameters:

  • id (String)
  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Returns:

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

    CreateEmployeeResult data, response status code and response headers



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 112

def employee_replace_with_http_info(id, , hris_create_employee_request_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeesApi.employee_replace ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EmployeesApi.employee_replace"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling EmployeesApi.employee_replace"
  end
  # verify the required parameter 'hris_create_employee_request_dto' is set
  if @api_client.config.client_side_validation && hris_create_employee_request_dto.nil?
    fail ArgumentError, "Missing the required parameter 'hris_create_employee_request_dto' when calling EmployeesApi.employee_replace"
  end
  # resource path
  local_var_path = '/unified/hris/employees/{id}'.sub('{' + 'id' + '}', CGI.escape(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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'x-account-id'] = 

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic']

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

#employee_update(id, x_account_id, hris_create_employee_request_dto, opts = {}) ⇒ CreateEmployeeResult

Updates an employee

Parameters:

  • id (String)
  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Returns:



180
181
182
183
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 180

def employee_update(id, , hris_create_employee_request_dto, opts = {})
  data, _status_code, _headers = employee_update_with_http_info(id, , hris_create_employee_request_dto, opts)
  data
end

#employee_update_with_http_info(id, x_account_id, hris_create_employee_request_dto, opts = {}) ⇒ Array<(CreateEmployeeResult, Integer, Hash)>

Updates an employee

Parameters:

  • id (String)
  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Returns:

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

    CreateEmployeeResult data, response status code and response headers



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 191

def employee_update_with_http_info(id, , hris_create_employee_request_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeesApi.employee_update ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EmployeesApi.employee_update"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling EmployeesApi.employee_update"
  end
  # verify the required parameter 'hris_create_employee_request_dto' is set
  if @api_client.config.client_side_validation && hris_create_employee_request_dto.nil?
    fail ArgumentError, "Missing the required parameter 'hris_create_employee_request_dto' when calling EmployeesApi.employee_update"
  end
  # resource path
  local_var_path = '/unified/hris/employees/{id}'.sub('{' + 'id' + '}', CGI.escape(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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'x-account-id'] = 

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic']

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

#hris_employees_get(id, x_account_id, opts = {}) ⇒ EmployeeResult

Get Employee

Parameters:

  • id (String)
  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    The page number of the results to fetch

  • :page_size (String) —

    The number of results per page (default to ‘25’)

  • :raw (Boolean) —

    Indicates that the raw request result is returned (default to false)

  • :fields (String) —

    The comma separated list of fields to return in the response (if empty, all fields are returned) (default to ”)

  • :sync_token (String) —

    The sync token to select the only updated results

  • :updated_after (String) —

    Use a string with a date to only select results updated after that given date

  • :expand (String) —

    The comma separated list of fields that will be expanded in the response (default to ”)

Returns:



265
266
267
268
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 265

def hris_employees_get(id, , opts = {})
  data, _status_code, _headers = hris_employees_get_with_http_info(id, , opts)
  data
end

#hris_employees_get_with_http_info(id, x_account_id, opts = {}) ⇒ Array<(EmployeeResult, Integer, Hash)>

Get Employee

Parameters:

  • id (String)
  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    The page number of the results to fetch

  • :page_size (String) —

    The number of results per page (default to ‘25’)

  • :raw (Boolean) —

    Indicates that the raw request result is returned (default to false)

  • :fields (String) —

    The comma separated list of fields to return in the response (if empty, all fields are returned) (default to ”)

  • :sync_token (String) —

    The sync token to select the only updated results

  • :updated_after (String) —

    Use a string with a date to only select results updated after that given date

  • :expand (String) —

    The comma separated list of fields that will be expanded in the response (default to ”)

Returns:

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

    EmployeeResult data, response status code and response headers



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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 282

def hris_employees_get_with_http_info(id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeesApi.hris_employees_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EmployeesApi.hris_employees_get"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling EmployeesApi.hris_employees_get"
  end
  # resource path
  local_var_path = '/unified/hris/employees/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
  query_params[:'updated_after'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic']

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

#hris_employees_list(x_account_id, opts = {}) ⇒ EmployeesPaginated

List Employees

Parameters:

  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    The page number of the results to fetch

  • :page_size (String) —

    The number of results per page (default to ‘25’)

  • :raw (Boolean) —

    Indicates that the raw request result is returned (default to false)

  • :fields (String) —

    The comma separated list of fields to return in the response (if empty, all fields are returned) (default to ”)

  • :sync_token (String) —

    The sync token to select the only updated results

  • :updated_after (String) —

    Use a string with a date to only select results updated after that given date

  • :expand (String) —

    The comma separated list of fields that will be expanded in the response (default to ”)

Returns:



354
355
356
357
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 354

def hris_employees_list(, opts = {})
  data, _status_code, _headers = hris_employees_list_with_http_info(, opts)
  data
end

#hris_employees_list_with_http_info(x_account_id, opts = {}) ⇒ Array<(EmployeesPaginated, Integer, Hash)>

List Employees

Parameters:

  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    The page number of the results to fetch

  • :page_size (String) —

    The number of results per page (default to ‘25’)

  • :raw (Boolean) —

    Indicates that the raw request result is returned (default to false)

  • :fields (String) —

    The comma separated list of fields to return in the response (if empty, all fields are returned) (default to ”)

  • :sync_token (String) —

    The sync token to select the only updated results

  • :updated_after (String) —

    Use a string with a date to only select results updated after that given date

  • :expand (String) —

    The comma separated list of fields that will be expanded in the response (default to ”)

Returns:

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

    EmployeesPaginated data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
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
 
# File 'lib/stackone_hris_client/api/employees_api.rb', line 370

def hris_employees_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeesApi.hris_employees_list ...'
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling EmployeesApi.hris_employees_list"
  end
  # resource path
  local_var_path = '/unified/hris/employees'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
  query_params[:'updated_after'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic']

  new_options = opts.merge(
    :operation => :"EmployeesApi.hris_employees_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeesApi#hris_employees_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end