Class: SmartRecruiters::ConfigurationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/smart_recruiters/api/configuration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationApi

Returns a new instance of ConfigurationApi.



5
6
7
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 5

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



3
4
5
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 3

def api_client
  @api_client
end

Instance Method Details

#configuration_candidate_properties_all(opts = {}) ⇒ CandidatePropertyDefinitionList

Get a list of available candidate properties Get all candidate properties and their configuration for a company

Parameters:

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

    the optional parameters

Returns:



12
13
14
15
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 12

def configuration_candidate_properties_all(opts = {})
  data, _status_code, _headers = configuration_candidate_properties_all_with_http_info(opts)
  data
end

#configuration_candidate_properties_all_with_http_info(opts = {}) ⇒ Array<(CandidatePropertyDefinitionList, Integer, Hash)>

Get a list of available candidate properties Get all candidate properties and their configuration for a company

Parameters:

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

    the optional parameters

Returns:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 21

def configuration_candidate_properties_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_candidate_properties_all ...'
  end
  # resource path
  local_var_path = '/configuration/candidate-properties'

  # 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[:body] 

  return_type = opts[:return_type] || 'CandidatePropertyDefinitionList' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_candidate_properties_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_candidate_properties_get(id, opts = {}) ⇒ CandidatePropertyDefinition

Get candidate property by id Get candidate property details and its configuration by id.

Parameters:

  • id —

    candidate property identifier

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

    the optional parameters

Returns:



63
64
65
66
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 63

def configuration_candidate_properties_get(id, opts = {})
  data, _status_code, _headers = configuration_candidate_properties_get_with_http_info(id, opts)
  data
end

#configuration_candidate_properties_get_with_http_info(id, opts = {}) ⇒ Array<(CandidatePropertyDefinition, Integer, Hash)>

Get candidate property by id Get candidate property details and its configuration by id.

Parameters:

  • id —

    candidate property identifier

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

    the optional parameters

Returns:

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

    CandidatePropertyDefinition data, response status code and response headers



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 73

def configuration_candidate_properties_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_candidate_properties_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 ConfigurationApi.configuration_candidate_properties_get"
  end
  # resource path
  local_var_path = '/configuration/candidate-properties/{id}'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] || 'CandidatePropertyDefinition' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_candidate_properties_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_candidate_properties_values_all(id, opts = {}) ⇒ CandidatePropertyValueList

Get Candidate Property values Lists all available values for given candidate property id. This endpoint is available only for SINGLE_SELECT candidate property type.

Parameters:

  • id —

    candidate property identifier

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

    the optional parameters

Returns:



119
120
121
122
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 119

def configuration_candidate_properties_values_all(id, opts = {})
  data, _status_code, _headers = configuration_candidate_properties_values_all_with_http_info(id, opts)
  data
end

#configuration_candidate_properties_values_all_with_http_info(id, opts = {}) ⇒ Array<(CandidatePropertyValueList, Integer, Hash)>

Get Candidate Property values Lists all available values for given candidate property id. This endpoint is available only for SINGLE_SELECT candidate property type.

Parameters:

  • id —

    candidate property identifier

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

    the optional parameters

Returns:

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

    CandidatePropertyValueList data, response status code and response headers



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
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 129

def configuration_candidate_properties_values_all_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_candidate_properties_values_all ...'
  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 ConfigurationApi.configuration_candidate_properties_values_all"
  end
  # resource path
  local_var_path = '/configuration/candidate-properties/{id}/values'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] || 'CandidatePropertyValueList' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_candidate_properties_values_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_candidate_properties_values_create(body, id, opts = {}) ⇒ CandidatePropertyValue

Create candidate property value Create SINGLE_SELECT candidate property value

Parameters:

  • body —

    Candidate property value.

  • id —

    candidate property identifier

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

    the optional parameters

Returns:



176
177
178
179
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 176

def configuration_candidate_properties_values_create(body, id, opts = {})
  data, _status_code, _headers = configuration_candidate_properties_values_create_with_http_info(body, id, opts)
  data
end

#configuration_candidate_properties_values_create_with_http_info(body, id, opts = {}) ⇒ Array<(CandidatePropertyValue, Integer, Hash)>

Create candidate property value Create SINGLE_SELECT candidate property value

Parameters:

  • body —

    Candidate property value.

  • id —

    candidate property identifier

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

    the optional parameters

Returns:

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

    CandidatePropertyValue data, response status code and response headers



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 187

def configuration_candidate_properties_values_create_with_http_info(body, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_candidate_properties_values_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConfigurationApi.configuration_candidate_properties_values_create"
  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 ConfigurationApi.configuration_candidate_properties_values_create"
  end
  # resource path
  local_var_path = '/configuration/candidate-properties/{id}/values'.sub('{' + 'id' + '}', 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'
  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[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CandidatePropertyValue' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_candidate_properties_values_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_candidate_properties_values_delete(id, value_id, opts = {}) ⇒ nil

Remove candidate property value Remove candidate property value label

Parameters:

  • id —

    candidate property identifier

  • value_id —

    candidate property&#x27;s value identifier

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

    the optional parameters

Returns:

  • (nil) 


240
241
242
243
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 240

def configuration_candidate_properties_values_delete(id, value_id, opts = {})
  configuration_candidate_properties_values_delete_with_http_info(id, value_id, opts)
  nil
end

#configuration_candidate_properties_values_delete_with_http_info(id, value_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove candidate property value Remove candidate property value label

Parameters:

  • id —

    candidate property identifier

  • value_id —

    candidate property&#x27;s value identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 251

def configuration_candidate_properties_values_delete_with_http_info(id, value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_candidate_properties_values_delete ...'
  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 ConfigurationApi.configuration_candidate_properties_values_delete"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_candidate_properties_values_delete"
  end
  # resource path
  local_var_path = '/configuration/candidate-properties/{id}/values/{valueId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_candidate_properties_values_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_candidate_properties_values_get(id, value_id, opts = {}) ⇒ CandidatePropertyValue

Get Candidate Property value by id Get Candidate Property value by its id.

Parameters:

  • id —

    candidate property identifier

  • value_id —

    candidate property&#x27;s value identifier

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

    the optional parameters

Returns:



302
303
304
305
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 302

def configuration_candidate_properties_values_get(id, value_id, opts = {})
  data, _status_code, _headers = configuration_candidate_properties_values_get_with_http_info(id, value_id, opts)
  data
end

#configuration_candidate_properties_values_get_with_http_info(id, value_id, opts = {}) ⇒ Array<(CandidatePropertyValue, Integer, Hash)>

Get Candidate Property value by id Get Candidate Property value by its id.

Parameters:

  • id —

    candidate property identifier

  • value_id —

    candidate property&#x27;s value identifier

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

    the optional parameters

Returns:

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

    CandidatePropertyValue data, response status code and response headers



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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 313

def configuration_candidate_properties_values_get_with_http_info(id, value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_candidate_properties_values_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 ConfigurationApi.configuration_candidate_properties_values_get"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_candidate_properties_values_get"
  end
  # resource path
  local_var_path = '/configuration/candidate-properties/{id}/values/{valueId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_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[:body] 

  return_type = opts[:return_type] || 'CandidatePropertyValue' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_candidate_properties_values_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_candidate_properties_values_update(body, id, value_id, opts = {}) ⇒ CandidatePropertyValue

Update candidate property value label Update candidate property value label

Parameters:

  • body —

    Candidate property value label.

  • id —

    candidate property identifier

  • value_id —

    candidate property&#x27;s value identifier

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

    the optional parameters

Returns:



365
366
367
368
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 365

def configuration_candidate_properties_values_update(body, id, value_id, opts = {})
  data, _status_code, _headers = configuration_candidate_properties_values_update_with_http_info(body, id, value_id, opts)
  data
end

#configuration_candidate_properties_values_update_with_http_info(body, id, value_id, opts = {}) ⇒ Array<(CandidatePropertyValue, Integer, Hash)>

Update candidate property value label Update candidate property value label

Parameters:

  • body —

    Candidate property value label.

  • id —

    candidate property identifier

  • value_id —

    candidate property&#x27;s value identifier

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

    the optional parameters

Returns:

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

    CandidatePropertyValue data, response status code and response headers



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
426
427
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 377

def configuration_candidate_properties_values_update_with_http_info(body, id, value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_candidate_properties_values_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConfigurationApi.configuration_candidate_properties_values_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 ConfigurationApi.configuration_candidate_properties_values_update"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_candidate_properties_values_update"
  end
  # resource path
  local_var_path = '/configuration/candidate-properties/{id}/values/{valueId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_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'
  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[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CandidatePropertyValue' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_candidate_properties_values_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_company_my(opts = {}) ⇒ CompanyConfiguration

Get company information Get all information about your company.

Parameters:

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

    the optional parameters

Returns:



432
433
434
435
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 432

def configuration_company_my(opts = {})
  data, _status_code, _headers = configuration_company_my_with_http_info(opts)
  data
end

#configuration_company_my_with_http_info(opts = {}) ⇒ Array<(CompanyConfiguration, Integer, Hash)>

Get company information Get all information about your company.

Parameters:

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

    the optional parameters

Returns:

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

    CompanyConfiguration data, response status code and response headers



441
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
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 441

def configuration_company_my_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_company_my ...'
  end
  # resource path
  local_var_path = '/configuration/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[:body] 

  return_type = opts[:return_type] || 'CompanyConfiguration' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_company_my\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_department_all(opts = {}) ⇒ Departments

Get departments

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:



482
483
484
485
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 482

def configuration_department_all(opts = {})
  data, _status_code, _headers = configuration_department_all_with_http_info(opts)
  data
end

#configuration_department_all_with_http_info(opts = {}) ⇒ Array<(Departments, Integer, Hash)>

Get departments

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:

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

    Departments data, response status code and response headers



491
492
493
494
495
496
497
498
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
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 491

def configuration_department_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_department_all ...'
  end
  # resource path
  local_var_path = '/configuration/departments'

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

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

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

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

  return_type = opts[:return_type] || 'Departments' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_department_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_department_create(body, opts = {}) ⇒ Department

Creates department

Parameters:

  • body —

    department to be created

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

    the optional parameters

Returns:



533
534
535
536
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 533

def configuration_department_create(body, opts = {})
  data, _status_code, _headers = configuration_department_create_with_http_info(body, opts)
  data
end

#configuration_department_create_with_http_info(body, opts = {}) ⇒ Array<(Department, Integer, Hash)>

Creates department

Parameters:

  • body —

    department to be created

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

    the optional parameters

Returns:

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

    Department data, response status code and response headers



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/smart_recruiters/api/configuration_api.rb', line 542

def configuration_department_create_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_department_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConfigurationApi.configuration_department_create"
  end
  # resource path
  local_var_path = '/configuration/departments'

  # 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[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'Department' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_department_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_department_get(id, opts = {}) ⇒ Department

Get department

Parameters:

  • id —

    Identifier of a department

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

    the optional parameters

Returns:



589
590
591
592
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 589

def configuration_department_get(id, opts = {})
  data, _status_code, _headers = configuration_department_get_with_http_info(id, opts)
  data
end

#configuration_department_get_with_http_info(id, opts = {}) ⇒ Array<(Department, Integer, Hash)>

Get department

Parameters:

  • id —

    Identifier of a department

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

    the optional parameters

Returns:

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

    Department data, response status code and response headers



598
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
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 598

def configuration_department_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_department_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 ConfigurationApi.configuration_department_get"
  end
  # resource path
  local_var_path = '/configuration/departments/{id}'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] || 'Department' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_department_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_hiring_process_all(opts = {}) ⇒ HiringProcesses

Get list of hiring process

Parameters:

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

    the optional parameters

Returns:



642
643
644
645
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 642

def configuration_hiring_process_all(opts = {})
  data, _status_code, _headers = configuration_hiring_process_all_with_http_info(opts)
  data
end

#configuration_hiring_process_all_with_http_info(opts = {}) ⇒ Array<(HiringProcesses, Integer, Hash)>

Get list of hiring process

Parameters:

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

    the optional parameters

Returns:

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

    HiringProcesses data, response status code and response headers



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 650

def configuration_hiring_process_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_hiring_process_all ...'
  end
  # resource path
  local_var_path = '/configuration/hiring-processes'

  # 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[:body] 

  return_type = opts[:return_type] || 'HiringProcesses' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_hiring_process_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_hiring_process_get(id, opts = {}) ⇒ HiringProcess

Get hiring process

Parameters:

  • id —

    Identifier of a hiring process

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

    the optional parameters

Returns:



691
692
693
694
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 691

def configuration_hiring_process_get(id, opts = {})
  data, _status_code, _headers = configuration_hiring_process_get_with_http_info(id, opts)
  data
end

#configuration_hiring_process_get_with_http_info(id, opts = {}) ⇒ Array<(HiringProcess, Integer, Hash)>

Get hiring process

Parameters:

  • id —

    Identifier of a hiring process

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

    the optional parameters

Returns:

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

    HiringProcess data, response status code and response headers



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 700

def configuration_hiring_process_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_hiring_process_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 ConfigurationApi.configuration_hiring_process_get"
  end
  # resource path
  local_var_path = '/configuration/hiring-processes/{id}'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] || 'HiringProcess' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_hiring_process_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_activate(id, opts = {}) ⇒ nil

Activate a job property Activates a job property with given id.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Returns:

  • (nil) 


746
747
748
749
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 746

def configuration_job_properties_activate(id, opts = {})
  configuration_job_properties_activate_with_http_info(id, opts)
  nil
end

#configuration_job_properties_activate_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Activate a job property Activates a job property with given id.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 756

def configuration_job_properties_activate_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_activate ...'
  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 ConfigurationApi.configuration_job_properties_activate"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/activation'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_activate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_all(opts = {}) ⇒ JobPropertyDefinitionList

Get a list of available job properties Get a list of available job properties.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:



802
803
804
805
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 802

def configuration_job_properties_all(opts = {})
  data, _status_code, _headers = configuration_job_properties_all_with_http_info(opts)
  data
end

#configuration_job_properties_all_with_http_info(opts = {}) ⇒ Array<(JobPropertyDefinitionList, Integer, Hash)>

Get a list of available job properties Get a list of available job properties.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:

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

    JobPropertyDefinitionList data, response status code and response headers



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 812

def configuration_job_properties_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_all ...'
  end
  # resource path
  local_var_path = '/configuration/job-properties'

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

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

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

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

  return_type = opts[:return_type] || 'JobPropertyDefinitionList' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_create(opts = {}) ⇒ JobPropertyDefinition

Create a job property Creates a job property

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



855
856
857
858
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 855

def configuration_job_properties_create(opts = {})
  data, _status_code, _headers = configuration_job_properties_create_with_http_info(opts)
  data
end

#configuration_job_properties_create_with_http_info(opts = {}) ⇒ Array<(JobPropertyDefinition, Integer, Hash)>

Create a job property Creates a job property

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    JobPropertyDefinition data, response status code and response headers



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
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 865

def configuration_job_properties_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_create ...'
  end
  # resource path
  local_var_path = '/configuration/job-properties'

  # 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[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] || 'JobPropertyDefinition' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_deactivate(id, opts = {}) ⇒ nil

Deactivate a job property Deactivates a job property.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Returns:

  • (nil) 


909
910
911
912
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 909

def configuration_job_properties_deactivate(id, opts = {})
  configuration_job_properties_deactivate_with_http_info(id, opts)
  nil
end

#configuration_job_properties_deactivate_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deactivate a job property Deactivates a job property.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



919
920
921
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
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 919

def configuration_job_properties_deactivate_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_deactivate ...'
  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 ConfigurationApi.configuration_job_properties_deactivate"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/activation'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_deactivate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_dependents_all(id, opts = {}) ⇒ DependentJobProperties

Get job property’s dependents Get list of job property’s dependents

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:



966
967
968
969
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 966

def configuration_job_properties_dependents_all(id, opts = {})
  data, _status_code, _headers = configuration_job_properties_dependents_all_with_http_info(id, opts)
  data
end

#configuration_job_properties_dependents_all_with_http_info(id, opts = {}) ⇒ Array<(DependentJobProperties, Integer, Hash)>

Get job property&#x27;s dependents Get list of job property&#x27;s dependents

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:

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

    DependentJobProperties data, response status code and response headers



977
978
979
980
981
982
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
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 977

def configuration_job_properties_dependents_all_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_dependents_all ...'
  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 ConfigurationApi.configuration_job_properties_dependents_all"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/dependents'.sub('{' + 'id' + '}', 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'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

  return_type = opts[:return_type] || 'DependentJobProperties' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_dependents_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_dependents_create(body, id, opts = {}) ⇒ DependentJobProperties

Create job property dependents Create dependencies between job properties

Parameters:

  • body —

    Job properties&#x27; id

  • id —

    job property identifier

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

    the optional parameters

Returns:



1025
1026
1027
1028
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1025

def configuration_job_properties_dependents_create(body, id, opts = {})
  data, _status_code, _headers = configuration_job_properties_dependents_create_with_http_info(body, id, opts)
  data
end

#configuration_job_properties_dependents_create_with_http_info(body, id, opts = {}) ⇒ Array<(DependentJobProperties, Integer, Hash)>

Create job property dependents Create dependencies between job properties

Parameters:

  • body —

    Job properties&#x27; id

  • id —

    job property identifier

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

    the optional parameters

Returns:

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

    DependentJobProperties data, response status code and response headers



1036
1037
1038
1039
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/smart_recruiters/api/configuration_api.rb', line 1036

def configuration_job_properties_dependents_create_with_http_info(body, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_dependents_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConfigurationApi.configuration_job_properties_dependents_create"
  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 ConfigurationApi.configuration_job_properties_dependents_create"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/dependents'.sub('{' + 'id' + '}', 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'
  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[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'DependentJobProperties' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_dependents_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_dependents_remove(id, dependent_id, opts = {}) ⇒ nil

Remove job property’s dependent Remove dependency between job properties

Parameters:

  • id —

    job property identifier

  • dependent_id —

    job property&#x27;s dependent identifier

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

    the optional parameters

Returns:

  • (nil) 


1089
1090
1091
1092
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1089

def configuration_job_properties_dependents_remove(id, dependent_id, opts = {})
  configuration_job_properties_dependents_remove_with_http_info(id, dependent_id, opts)
  nil
end

#configuration_job_properties_dependents_remove_with_http_info(id, dependent_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove job property&#x27;s dependent Remove dependency between job properties

Parameters:

  • id —

    job property identifier

  • dependent_id —

    job property&#x27;s dependent identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1140
1141
1142
1143
1144
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1100

def configuration_job_properties_dependents_remove_with_http_info(id, dependent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_dependents_remove ...'
  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 ConfigurationApi.configuration_job_properties_dependents_remove"
  end
  # verify the required parameter 'dependent_id' is set
  if @api_client.config.client_side_validation && dependent_id.nil?
    fail ArgumentError, "Missing the required parameter 'dependent_id' when calling ConfigurationApi.configuration_job_properties_dependents_remove"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/dependents/{dependentId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'dependentId' + '}', dependent_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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_dependents_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_dependents_values_add(body, id, value_id, dependent_id, opts = {}) ⇒ nil

Add job property’s dependent value Add job property’s dependent value for specific job property’s value

Parameters:

  • body —

    Identifier of job property&#x27;s dependent value

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

  • dependent_id —

    job property&#x27;s dependent identifier

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

    the optional parameters

Returns:

  • (nil) 


1153
1154
1155
1156
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1153

def configuration_job_properties_dependents_values_add(body, id, value_id, dependent_id, opts = {})
  configuration_job_properties_dependents_values_add_with_http_info(body, id, value_id, dependent_id, opts)
  nil
end

#configuration_job_properties_dependents_values_add_with_http_info(body, id, value_id, dependent_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add job property&#x27;s dependent value Add job property&#x27;s dependent value for specific job property&#x27;s value

Parameters:

  • body —

    Identifier of job property&#x27;s dependent value

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

  • dependent_id —

    job property&#x27;s dependent identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1166

def configuration_job_properties_dependents_values_add_with_http_info(body, id, value_id, dependent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_dependents_values_add ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConfigurationApi.configuration_job_properties_dependents_values_add"
  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 ConfigurationApi.configuration_job_properties_dependents_values_add"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_job_properties_dependents_values_add"
  end
  # verify the required parameter 'dependent_id' is set
  if @api_client.config.client_side_validation && dependent_id.nil?
    fail ArgumentError, "Missing the required parameter 'dependent_id' when calling ConfigurationApi.configuration_job_properties_dependents_values_add"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/values/{valueId}/dependents/{dependentId}/values'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_id.to_s).sub('{' + 'dependentId' + '}', dependent_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'
  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[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_dependents_values_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_dependents_values_all(id, dependent_id, opts = {}) ⇒ DependentJobPropertyValuesRelations

Get dependent job property’s values Get dependent job property’s values with corelation to the parent field.

Parameters:

  • id —

    job property identifier

  • dependent_id —

    job property&#x27;s dependent identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:



1228
1229
1230
1231
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1228

def configuration_job_properties_dependents_values_all(id, dependent_id, opts = {})
  data, _status_code, _headers = configuration_job_properties_dependents_values_all_with_http_info(id, dependent_id, opts)
  data
end

#configuration_job_properties_dependents_values_all_with_http_info(id, dependent_id, opts = {}) ⇒ Array<(DependentJobPropertyValuesRelations, Integer, Hash)>

Get dependent job property&#x27;s values Get dependent job property&#x27;s values with corelation to the parent field.

Parameters:

  • id —

    job property identifier

  • dependent_id —

    job property&#x27;s dependent identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:



1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1240

def configuration_job_properties_dependents_values_all_with_http_info(id, dependent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_dependents_values_all ...'
  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 ConfigurationApi.configuration_job_properties_dependents_values_all"
  end
  # verify the required parameter 'dependent_id' is set
  if @api_client.config.client_side_validation && dependent_id.nil?
    fail ArgumentError, "Missing the required parameter 'dependent_id' when calling ConfigurationApi.configuration_job_properties_dependents_values_all"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/dependents/{dependentId}/values'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'dependentId' + '}', dependent_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'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

  return_type = opts[:return_type] || 'DependentJobPropertyValuesRelations' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_dependents_values_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_dependents_values_get(id, value_id, dependent_id, opts = {}) ⇒ DependentJobPropertyValues

Get job property’s dependent values Get list of job property’s dependent values for specific job property’s value

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

  • dependent_id —

    job property&#x27;s dependent identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:



1294
1295
1296
1297
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1294

def configuration_job_properties_dependents_values_get(id, value_id, dependent_id, opts = {})
  data, _status_code, _headers = configuration_job_properties_dependents_values_get_with_http_info(id, value_id, dependent_id, opts)
  data
end

#configuration_job_properties_dependents_values_get_with_http_info(id, value_id, dependent_id, opts = {}) ⇒ Array<(DependentJobPropertyValues, Integer, Hash)>

Get job property&#x27;s dependent values Get list of job property&#x27;s dependent values for specific job property&#x27;s value

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

  • dependent_id —

    job property&#x27;s dependent identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:

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

    DependentJobPropertyValues data, response status code and response headers



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1307

def configuration_job_properties_dependents_values_get_with_http_info(id, value_id, dependent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_dependents_values_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 ConfigurationApi.configuration_job_properties_dependents_values_get"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_job_properties_dependents_values_get"
  end
  # verify the required parameter 'dependent_id' is set
  if @api_client.config.client_side_validation && dependent_id.nil?
    fail ArgumentError, "Missing the required parameter 'dependent_id' when calling ConfigurationApi.configuration_job_properties_dependents_values_get"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/values/{valueId}/dependents/{dependentId}/values'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_id.to_s).sub('{' + 'dependentId' + '}', dependent_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'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

  return_type = opts[:return_type] || 'DependentJobPropertyValues' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_dependents_values_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_dependents_values_remove(id, value_id, dependent_id, dependent_value_id, opts = {}) ⇒ nil

Remove job property’s dependent values relationship Remove relationship between dependent job properties values

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

  • dependent_id —

    job property&#x27;s dependent identifier

  • dependent_value_id —

    job property&#x27;s dependent value identifier

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

    the optional parameters

Returns:

  • (nil) 


1365
1366
1367
1368
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1365

def configuration_job_properties_dependents_values_remove(id, value_id, dependent_id, dependent_value_id, opts = {})
  configuration_job_properties_dependents_values_remove_with_http_info(id, value_id, dependent_id, dependent_value_id, opts)
  nil
end

#configuration_job_properties_dependents_values_remove_with_http_info(id, value_id, dependent_id, dependent_value_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove job property&#x27;s dependent values relationship Remove relationship between dependent job properties values

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

  • dependent_id —

    job property&#x27;s dependent identifier

  • dependent_value_id —

    job property&#x27;s dependent value identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1378

def configuration_job_properties_dependents_values_remove_with_http_info(id, value_id, dependent_id, dependent_value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_dependents_values_remove ...'
  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 ConfigurationApi.configuration_job_properties_dependents_values_remove"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_job_properties_dependents_values_remove"
  end
  # verify the required parameter 'dependent_id' is set
  if @api_client.config.client_side_validation && dependent_id.nil?
    fail ArgumentError, "Missing the required parameter 'dependent_id' when calling ConfigurationApi.configuration_job_properties_dependents_values_remove"
  end
  # verify the required parameter 'dependent_value_id' is set
  if @api_client.config.client_side_validation && dependent_value_id.nil?
    fail ArgumentError, "Missing the required parameter 'dependent_value_id' when calling ConfigurationApi.configuration_job_properties_dependents_values_remove"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/values/{valueId}/dependents/{dependentId}/values/{dependentValueId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_id.to_s).sub('{' + 'dependentId' + '}', dependent_id.to_s).sub('{' + 'dependentValueId' + '}', dependent_value_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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_dependents_values_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_get(id, opts = {}) ⇒ JobPropertyDefinition

Get job property by id Get job property by id

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:



1437
1438
1439
1440
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1437

def configuration_job_properties_get(id, opts = {})
  data, _status_code, _headers = configuration_job_properties_get_with_http_info(id, opts)
  data
end

#configuration_job_properties_get_with_http_info(id, opts = {}) ⇒ Array<(JobPropertyDefinition, Integer, Hash)>

Get job property by id Get job property by id

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:

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

    JobPropertyDefinition data, response status code and response headers



1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1448

def configuration_job_properties_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_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 ConfigurationApi.configuration_job_properties_get"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}'.sub('{' + 'id' + '}', 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'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

  return_type = opts[:return_type] || 'JobPropertyDefinition' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_translations_patch(body, id, opts = {}) ⇒ nil

Add a job property’s translations Submit a job property’s translations to different languages

Parameters:

  • body
  • id —

    job property identifier

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

    the optional parameters

Returns:

  • (nil) 


1496
1497
1498
1499
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1496

def configuration_job_properties_translations_patch(body, id, opts = {})
  configuration_job_properties_translations_patch_with_http_info(body, id, opts)
  nil
end

#configuration_job_properties_translations_patch_with_http_info(body, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add a job property&#x27;s translations Submit a job property&#x27;s translations to different languages

Parameters:

  • body
  • id —

    job property identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1507

def configuration_job_properties_translations_patch_with_http_info(body, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_translations_patch ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConfigurationApi.configuration_job_properties_translations_patch"
  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 ConfigurationApi.configuration_job_properties_translations_patch"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/translations'.sub('{' + 'id' + '}', 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'
  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[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_translations_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_update(id, opts = {}) ⇒ JobPropertyDefinition

Update a job property Updates a job property.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Object>) —

    patch request

Returns:



1560
1561
1562
1563
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1560

def configuration_job_properties_update(id, opts = {})
  data, _status_code, _headers = configuration_job_properties_update_with_http_info(id, opts)
  data
end

#configuration_job_properties_update_with_http_info(id, opts = {}) ⇒ Array<(JobPropertyDefinition, Integer, Hash)>

Update a job property Updates a job property.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Object>) —

    patch request

Returns:

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

    JobPropertyDefinition data, response status code and response headers



1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1571

def configuration_job_properties_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_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 ConfigurationApi.configuration_job_properties_update"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}'.sub('{' + 'id' + '}', 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json'])

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

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

  return_type = opts[:return_type] || 'JobPropertyDefinition' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_values_archive(id, value_id, opts = {}) ⇒ nil

Archive a job property value Archive a job property value

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

  • (nil) 


1620
1621
1622
1623
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1620

def configuration_job_properties_values_archive(id, value_id, opts = {})
  configuration_job_properties_values_archive_with_http_info(id, value_id, opts)
  nil
end

#configuration_job_properties_values_archive_with_http_info(id, value_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Archive a job property value Archive a job property value

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1631

def configuration_job_properties_values_archive_with_http_info(id, value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_values_archive ...'
  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 ConfigurationApi.configuration_job_properties_values_archive"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_job_properties_values_archive"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/archive-values/{valueId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_values_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_values_create(id, opts = {}) ⇒ JobPropertyValueDefinition

Create a job property value Creates a job property value.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

Returns:



1682
1683
1684
1685
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1682

def configuration_job_properties_values_create(id, opts = {})
  data, _status_code, _headers = configuration_job_properties_values_create_with_http_info(id, opts)
  data
end

#configuration_job_properties_values_create_with_http_info(id, opts = {}) ⇒ Array<(JobPropertyValueDefinition, Integer, Hash)>

Create a job property value Creates a job property value.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

Returns:

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

    JobPropertyValueDefinition data, response status code and response headers



1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1693

def configuration_job_properties_values_create_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_values_create ...'
  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 ConfigurationApi.configuration_job_properties_values_create"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/values'.sub('{' + 'id' + '}', 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'
  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[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] || 'JobPropertyValueDefinition' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_values_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_values_deprecated_archive(id, value_id, opts = {}) ⇒ nil

Archive a job property value Archive a job property value. Please use ‘PUT /configuration/job-properties/id/archive-values/valueId` instead.

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

  • (nil) 


1742
1743
1744
1745
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1742

def configuration_job_properties_values_deprecated_archive(id, value_id, opts = {})
  configuration_job_properties_values_deprecated_archive_with_http_info(id, value_id, opts)
  nil
end

#configuration_job_properties_values_deprecated_archive_with_http_info(id, value_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Archive a job property value Archive a job property value. Please use &#x60;PUT /configuration/job-properties/id/archive-values/valueId&#x60; instead.

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1753

def configuration_job_properties_values_deprecated_archive_with_http_info(id, value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_values_deprecated_archive ...'
  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 ConfigurationApi.configuration_job_properties_values_deprecated_archive"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_job_properties_values_deprecated_archive"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/values/{valueId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_values_deprecated_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_values_deprecated_unarchive(id, value_id, opts = {}) ⇒ nil

Unarchive a job property value Unarchive a job property value. ‘DELETE /configuration/job-properties/id/archive-values/valueId` instead.

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

  • (nil) 


1804
1805
1806
1807
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1804

def configuration_job_properties_values_deprecated_unarchive(id, value_id, opts = {})
  configuration_job_properties_values_deprecated_unarchive_with_http_info(id, value_id, opts)
  nil
end

#configuration_job_properties_values_deprecated_unarchive_with_http_info(id, value_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unarchive a job property value Unarchive a job property value. &#x60;DELETE /configuration/job-properties/id/archive-values/valueId&#x60; instead.

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1815

def configuration_job_properties_values_deprecated_unarchive_with_http_info(id, value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_values_deprecated_unarchive ...'
  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 ConfigurationApi.configuration_job_properties_values_deprecated_unarchive"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_job_properties_values_deprecated_unarchive"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/values/{valueId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_values_deprecated_unarchive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_values_get(id, opts = {}) ⇒ JobPropertyValueDefinitionList

Get available job property values Get available job property values.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:



1866
1867
1868
1869
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1866

def configuration_job_properties_values_get(id, opts = {})
  data, _status_code, _headers = configuration_job_properties_values_get_with_http_info(id, opts)
  data
end

#configuration_job_properties_values_get_with_http_info(id, opts = {}) ⇒ Array<(JobPropertyValueDefinitionList, Integer, Hash)>

Get available job property values Get available job property values.

Parameters:

  • id —

    job property identifier

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

    the optional parameters

Options Hash (opts):

  • :accept_language (LanguageCode) —

    language of returned content

Returns:



1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1877

def configuration_job_properties_values_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_values_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 ConfigurationApi.configuration_job_properties_values_get"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/values'.sub('{' + 'id' + '}', 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'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

  return_type = opts[:return_type] || 'JobPropertyValueDefinitionList' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_values_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_values_translations_patch(body, id, value_id, opts = {}) ⇒ nil

Add a job property value’s translations Submit a job property value’s translations to different languages

Parameters:

  • body
  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

  • (nil) 


1926
1927
1928
1929
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1926

def configuration_job_properties_values_translations_patch(body, id, value_id, opts = {})
  configuration_job_properties_values_translations_patch_with_http_info(body, id, value_id, opts)
  nil
end

#configuration_job_properties_values_translations_patch_with_http_info(body, id, value_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add a job property value&#x27;s translations Submit a job property value&#x27;s translations to different languages

Parameters:

  • body
  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1938

def configuration_job_properties_values_translations_patch_with_http_info(body, id, value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_values_translations_patch ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConfigurationApi.configuration_job_properties_values_translations_patch"
  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 ConfigurationApi.configuration_job_properties_values_translations_patch"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_job_properties_values_translations_patch"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/values/{valueId}/translations'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_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'
  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[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_values_translations_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_values_unarchive(id, value_id, opts = {}) ⇒ nil

Unarchive a job property value Unarchive a job property value

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

  • (nil) 


1995
1996
1997
1998
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 1995

def configuration_job_properties_values_unarchive(id, value_id, opts = {})
  configuration_job_properties_values_unarchive_with_http_info(id, value_id, opts)
  nil
end

#configuration_job_properties_values_unarchive_with_http_info(id, value_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unarchive a job property value Unarchive a job property value

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2006

def configuration_job_properties_values_unarchive_with_http_info(id, value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_values_unarchive ...'
  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 ConfigurationApi.configuration_job_properties_values_unarchive"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_job_properties_values_unarchive"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/archive-values/{valueId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_values_unarchive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_job_properties_values_update(id, value_id, opts = {}) ⇒ JobPropertyValueDefinition

Update a job property value Update a job property value. Returns an updated job property value object.

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Object>) —

    patch request

Returns:



2058
2059
2060
2061
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2058

def configuration_job_properties_values_update(id, value_id, opts = {})
  data, _status_code, _headers = configuration_job_properties_values_update_with_http_info(id, value_id, opts)
  data
end

#configuration_job_properties_values_update_with_http_info(id, value_id, opts = {}) ⇒ Array<(JobPropertyValueDefinition, Integer, Hash)>

Update a job property value Update a job property value. Returns an updated job property value object.

Parameters:

  • id —

    job property identifier

  • value_id —

    job property&#x27;s value identifier

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Object>) —

    patch request

Returns:

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

    JobPropertyValueDefinition data, response status code and response headers



2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2070

def configuration_job_properties_values_update_with_http_info(id, value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_job_properties_values_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 ConfigurationApi.configuration_job_properties_values_update"
  end
  # verify the required parameter 'value_id' is set
  if @api_client.config.client_side_validation && value_id.nil?
    fail ArgumentError, "Missing the required parameter 'value_id' when calling ConfigurationApi.configuration_job_properties_values_update"
  end
  # resource path
  local_var_path = '/configuration/job-properties/{id}/values/{valueId}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'valueId' + '}', value_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json'])

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

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

  return_type = opts[:return_type] || 'JobPropertyValueDefinition' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_job_properties_values_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_offer_properties_all(opts = {}) ⇒ OfferPropertiesDefinition

Get a list of available offer properties Get a list of available offer properties.

Parameters:

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

    the optional parameters

Returns:



2121
2122
2123
2124
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2121

def configuration_offer_properties_all(opts = {})
  data, _status_code, _headers = configuration_offer_properties_all_with_http_info(opts)
  data
end

#configuration_offer_properties_all_with_http_info(opts = {}) ⇒ Array<(OfferPropertiesDefinition, Integer, Hash)>

Get a list of available offer properties Get a list of available offer properties.

Parameters:

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

    the optional parameters

Returns:

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

    OfferPropertiesDefinition data, response status code and response headers



2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2130

def configuration_offer_properties_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_offer_properties_all ...'
  end
  # resource path
  local_var_path = '/configuration/offer-properties'

  # 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[:body] 

  return_type = opts[:return_type] || 'OfferPropertiesDefinition' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_offer_properties_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_reasons_rejection_all(opts = {}) ⇒ Properties

Get rejection reasons Get rejection reasons

Parameters:

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

    the optional parameters

Returns:



2171
2172
2173
2174
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2171

def configuration_reasons_rejection_all(opts = {})
  data, _status_code, _headers = configuration_reasons_rejection_all_with_http_info(opts)
  data
end

#configuration_reasons_rejection_all_with_http_info(opts = {}) ⇒ Array<(Properties, Integer, Hash)>

Get rejection reasons Get rejection reasons

Parameters:

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

    the optional parameters

Returns:

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

    Properties data, response status code and response headers



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2180

def configuration_reasons_rejection_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_reasons_rejection_all ...'
  end
  # resource path
  local_var_path = '/configuration/rejection-reasons'

  # 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[:body] 

  return_type = opts[:return_type] || 'Properties' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_reasons_rejection_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_reasons_withdrawal_all(opts = {}) ⇒ Properties

Get withdrawal reasons Get withdrawal reasons

Parameters:

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

    the optional parameters

Returns:



2221
2222
2223
2224
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2221

def configuration_reasons_withdrawal_all(opts = {})
  data, _status_code, _headers = configuration_reasons_withdrawal_all_with_http_info(opts)
  data
end

#configuration_reasons_withdrawal_all_with_http_info(opts = {}) ⇒ Array<(Properties, Integer, Hash)>

Get withdrawal reasons Get withdrawal reasons

Parameters:

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

    the optional parameters

Returns:

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

    Properties data, response status code and response headers



2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2230

def configuration_reasons_withdrawal_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_reasons_withdrawal_all ...'
  end
  # resource path
  local_var_path = '/configuration/withdrawal-reasons'

  # 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[:body] 

  return_type = opts[:return_type] || 'Properties' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_reasons_withdrawal_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_source_types(opts = {}) ⇒ SourceTypes

List candidate source types with subtypes Get a list of all available candidate source type with subtypes

Parameters:

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

    the optional parameters

Returns:



2271
2272
2273
2274
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2271

def configuration_source_types(opts = {})
  data, _status_code, _headers = configuration_source_types_with_http_info(opts)
  data
end

#configuration_source_types_with_http_info(opts = {}) ⇒ Array<(SourceTypes, Integer, Hash)>

List candidate source types with subtypes Get a list of all available candidate source type with subtypes

Parameters:

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

    the optional parameters

Returns:

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

    SourceTypes data, response status code and response headers



2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2280

def configuration_source_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_source_types ...'
  end
  # resource path
  local_var_path = '/configuration/sources'

  # 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[:body] 

  return_type = opts[:return_type] || 'SourceTypes' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_source_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_source_values_all(source_type, opts = {}) ⇒ Sources

List candidate sources Get a list of all available candidate sources by type.

Parameters:

  • source_type —

    Source type from /configuration/sources

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

    the optional parameters

Options Hash (opts):

  • :source_sub_type (String) —

    Source SubType from /configuration/sources

  • :limit (Integer) —

    number of elements to return. max value is 100 (default to 100)

  • :offset (Integer) —

    number of elements to skip while processing result (default to 0)

Returns:



2325
2326
2327
2328
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2325

def configuration_source_values_all(source_type, opts = {})
  data, _status_code, _headers = configuration_source_values_all_with_http_info(source_type, opts)
  data
end

#configuration_source_values_all_with_http_info(source_type, opts = {}) ⇒ Array<(Sources, Integer, Hash)>

List candidate sources Get a list of all available candidate sources by type.

Parameters:

  • source_type —

    Source type from /configuration/sources

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

    the optional parameters

Options Hash (opts):

  • :source_sub_type (String) —

    Source SubType from /configuration/sources

  • :limit (Integer) —

    number of elements to return. max value is 100

  • :offset (Integer) —

    number of elements to skip while processing result

Returns:

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

    Sources data, response status code and response headers



2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2338

def configuration_source_values_all_with_http_info(source_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_source_values_all ...'
  end
  # verify the required parameter 'source_type' is set
  if @api_client.config.client_side_validation && source_type.nil?
    fail ArgumentError, "Missing the required parameter 'source_type' when calling ConfigurationApi.configuration_source_values_all"
  end
  # resource path
  local_var_path = '/configuration/sources/{sourceType}/values'.sub('{' + 'sourceType' + '}', source_type.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sourceSubType'] = opts[:'source_sub_type'] if !opts[:'source_sub_type'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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[:body] 

  return_type = opts[:return_type] || 'Sources' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_source_values_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_source_values_single(source_type, source_value_id, opts = {}) ⇒ Source

Get a candidate source Get a single candidate sources for a given type.

Parameters:

  • source_type —

    Source type from /configuration/sources

  • source_value_id —

    Source id

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

    the optional parameters

Options Hash (opts):

  • :source_sub_type (String) —

    Source SubType from /configuration/sources

Returns:



2389
2390
2391
2392
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2389

def configuration_source_values_single(source_type, source_value_id, opts = {})
  data, _status_code, _headers = configuration_source_values_single_with_http_info(source_type, source_value_id, opts)
  data
end

#configuration_source_values_single_by_identifier(source_identifier, opts = {}) ⇒ SourceDefinition

Get a candidate source by identifier. Get a single candidate source for a given identifier (included deleted source).

Parameters:

  • source_identifier —

    Source identifier

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

    the optional parameters

Returns:



2452
2453
2454
2455
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2452

def configuration_source_values_single_by_identifier(source_identifier, opts = {})
  data, _status_code, _headers = configuration_source_values_single_by_identifier_with_http_info(source_identifier, opts)
  data
end

#configuration_source_values_single_by_identifier_with_http_info(source_identifier, opts = {}) ⇒ Array<(SourceDefinition, Integer, Hash)>

Get a candidate source by identifier. Get a single candidate source for a given identifier (included deleted source).

Parameters:

  • source_identifier —

    Source identifier

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

    the optional parameters

Returns:

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

    SourceDefinition data, response status code and response headers



2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2462

def configuration_source_values_single_by_identifier_with_http_info(source_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_source_values_single_by_identifier ...'
  end
  # verify the required parameter 'source_identifier' is set
  if @api_client.config.client_side_validation && source_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'source_identifier' when calling ConfigurationApi.configuration_source_values_single_by_identifier"
  end
  # resource path
  local_var_path = '/configuration/sources/{sourceIdentifier}'.sub('{' + 'sourceIdentifier' + '}', source_identifier.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[:body] 

  return_type = opts[:return_type] || 'SourceDefinition' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_source_values_single_by_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configuration_source_values_single_with_http_info(source_type, source_value_id, opts = {}) ⇒ Array<(Source, Integer, Hash)>

Get a candidate source Get a single candidate sources for a given type.

Parameters:

  • source_type —

    Source type from /configuration/sources

  • source_value_id —

    Source id

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

    the optional parameters

Options Hash (opts):

  • :source_sub_type (String) —

    Source SubType from /configuration/sources

Returns:

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

    Source data, response status code and response headers



2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
 
# File 'lib/smart_recruiters/api/configuration_api.rb', line 2401

def configuration_source_values_single_with_http_info(source_type, source_value_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.configuration_source_values_single ...'
  end
  # verify the required parameter 'source_type' is set
  if @api_client.config.client_side_validation && source_type.nil?
    fail ArgumentError, "Missing the required parameter 'source_type' when calling ConfigurationApi.configuration_source_values_single"
  end
  # verify the required parameter 'source_value_id' is set
  if @api_client.config.client_side_validation && source_value_id.nil?
    fail ArgumentError, "Missing the required parameter 'source_value_id' when calling ConfigurationApi.configuration_source_values_single"
  end
  # resource path
  local_var_path = '/configuration/sources/{sourceType}/values/{sourceValueId}'.sub('{' + 'sourceType' + '}', source_type.to_s).sub('{' + 'sourceValueId' + '}', source_value_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sourceSubType'] = opts[:'source_sub_type'] if !opts[:'source_sub_type'].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[:body] 

  return_type = opts[:return_type] || 'Source' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#configuration_source_values_single\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end