Class: MergeATSClient::CandidatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ats_client/api/candidates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CandidatesApi

Returns a new instance of CandidatesApi.



19
20
21
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#candidates_create(x_account_token, candidate_endpoint_request, opts = {}) ⇒ CandidateResponse

Creates a ‘Candidate` object with the given values.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :is_debug_mode (Boolean) —

    Whether to include debug fields (such as log file links) in the response.

  • :run_async (Boolean) —

    Whether or not third-party updates should be run asynchronously.

Returns:



29
30
31
32
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 29

def candidates_create(, candidate_endpoint_request, opts = {})
  data, _status_code, _headers = candidates_create_with_http_info(, candidate_endpoint_request, opts)
  data
end

#candidates_create_with_http_info(x_account_token, candidate_endpoint_request, opts = {}) ⇒ Array<(CandidateResponse, Integer, Hash)>

Creates a &#x60;Candidate&#x60; object with the given values.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :is_debug_mode (Boolean) —

    Whether to include debug fields (such as log file links) in the response.

  • :run_async (Boolean) —

    Whether or not third-party updates should be run asynchronously.

Returns:

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

    CandidateResponse data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 41

def candidates_create_with_http_info(, candidate_endpoint_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CandidatesApi.candidates_create ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling CandidatesApi.candidates_create"
  end
  # verify the required parameter 'candidate_endpoint_request' is set
  if @api_client.config.client_side_validation && candidate_endpoint_request.nil?
    fail ArgumentError, "Missing the required parameter 'candidate_endpoint_request' when calling CandidatesApi.candidates_create"
  end
  # resource path
  local_var_path = '/candidates'

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

  # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  header_params[:'X-Account-Token'] = 

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

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

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

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

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

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

#candidates_ignore_create(x_account_token, model_id, ignore_common_model_request, opts = {}) ⇒ IgnoreCommonModel

Ignores a specific row based on the ‘model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • model_id (String)
  • ignore_common_model_request (IgnoreCommonModelRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



104
105
106
107
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 104

def candidates_ignore_create(, model_id, ignore_common_model_request, opts = {})
  data, _status_code, _headers = candidates_ignore_create_with_http_info(, model_id, ignore_common_model_request, opts)
  data
end

#candidates_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request, opts = {}) ⇒ Array<(IgnoreCommonModel, Integer, Hash)>

Ignores a specific row based on the &#x60;model_id&#x60; in the url. These records will have their properties set to null, and will not be updated in future syncs. The &quot;reason&quot; and &quot;message&quot; fields in the request body will be stored for audit purposes.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • model_id (String)
  • ignore_common_model_request (IgnoreCommonModelRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    IgnoreCommonModel data, response status code and response headers



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

def candidates_ignore_create_with_http_info(, model_id, ignore_common_model_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CandidatesApi.candidates_ignore_create ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling CandidatesApi.candidates_ignore_create"
  end
  # verify the required parameter 'model_id' is set
  if @api_client.config.client_side_validation && model_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_id' when calling CandidatesApi.candidates_ignore_create"
  end
  # verify the required parameter 'ignore_common_model_request' is set
  if @api_client.config.client_side_validation && ignore_common_model_request.nil?
    fail ArgumentError, "Missing the required parameter 'ignore_common_model_request' when calling CandidatesApi.candidates_ignore_create"
  end
  # resource path
  local_var_path = '/candidates/ignore/{model_id}'.sub('{' + 'model_id' + '}', CGI.escape(model_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', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  header_params[:'X-Account-Token'] = 

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

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

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

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

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

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

#candidates_list(x_account_token, opts = {}) ⇒ PaginatedCandidateList

Returns a list of ‘Candidate` objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :created_after (Time) —

    If provided, will only return objects created after this datetime.

  • :created_before (Time) —

    If provided, will only return objects created before this datetime.

  • :cursor (String) —

    The pagination cursor value.

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :first_name (String) —

    If provided, will only return candidates with this first name.

  • :include_deleted_data (Boolean) —

    Whether to include data that was deleted in the third-party service.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :last_name (String) —

    If provided, will only return candidates with this last name.

  • :modified_after (Time) —

    If provided, will only return objects modified after this datetime.

  • :modified_before (Time) —

    If provided, will only return objects modified before this datetime.

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_id (String) —

    The API provider&#39;s ID for the given object.

Returns:



190
191
192
193
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 190

def candidates_list(, opts = {})
  data, _status_code, _headers = candidates_list_with_http_info(, opts)
  data
end

#candidates_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedCandidateList, Integer, Hash)>

Returns a list of &#x60;Candidate&#x60; objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :created_after (Time) —

    If provided, will only return objects created after this datetime.

  • :created_before (Time) —

    If provided, will only return objects created before this datetime.

  • :cursor (String) —

    The pagination cursor value.

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :first_name (String) —

    If provided, will only return candidates with this first name.

  • :include_deleted_data (Boolean) —

    Whether to include data that was deleted in the third-party service.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :last_name (String) —

    If provided, will only return candidates with this last name.

  • :modified_after (Time) —

    If provided, will only return objects modified after this datetime.

  • :modified_before (Time) —

    If provided, will only return objects modified before this datetime.

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_id (String) —

    The API provider&#39;s ID for the given object.

Returns:

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

    PaginatedCandidateList data, response status code and response headers



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 211

def candidates_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CandidatesApi.candidates_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling CandidatesApi.candidates_list"
  end
  allowable_values = ["applications", "applications,attachments", "attachments"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
    fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/candidates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?

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

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

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

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

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

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

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

#candidates_meta_post_retrieve(x_account_token, opts = {}) ⇒ MetaResponse

Returns metadata for ‘Candidate` POSTs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Returns:



280
281
282
283
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 280

def candidates_meta_post_retrieve(, opts = {})
  data, _status_code, _headers = candidates_meta_post_retrieve_with_http_info(, opts)
  data
end

#candidates_meta_post_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>

Returns metadata for &#x60;Candidate&#x60; POSTs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Returns:

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

    MetaResponse data, response status code and response headers



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 289

def candidates_meta_post_retrieve_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CandidatesApi.candidates_meta_post_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling CandidatesApi.candidates_meta_post_retrieve"
  end
  # resource path
  local_var_path = '/candidates/meta/post'

  # 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[:'X-Account-Token'] = 

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

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

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

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

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

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

#candidates_retrieve(x_account_token, id, opts = {}) ⇒ Candidate

Returns a ‘Candidate` object with the given `id`.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

Returns:



345
346
347
348
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 345

def candidates_retrieve(, id, opts = {})
  data, _status_code, _headers = candidates_retrieve_with_http_info(, id, opts)
  data
end

#candidates_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Candidate, Integer, Hash)>

Returns a &#x60;Candidate&#x60; object with the given &#x60;id&#x60;.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

Returns:

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

    Candidate data, response status code and response headers



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
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
 
# File 'lib/merge_ats_client/api/candidates_api.rb', line 357

def candidates_retrieve_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CandidatesApi.candidates_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling CandidatesApi.candidates_retrieve"
  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 CandidatesApi.candidates_retrieve"
  end
  allowable_values = ["applications", "applications,attachments", "attachments"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
    fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/candidates/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

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

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

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

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

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

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

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