Class: CrelateClient::JobPostingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crelate_client/api/job_postings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ JobPostingsApi

Returns a new instance of JobPostingsApi.



19
20
21
 
# File 'lib/crelate_client/api/job_postings_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/crelate_client/api/job_postings_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#public_api_delete_job_postings(job_id, api_key, opts = {}) ⇒ Object

delete a job posting

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


29
30
31
32
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 29

def public_api_delete_job_postings(job_id, api_key, opts = {})
  data, _status_code, _headers = public_api_delete_job_postings_with_http_info(job_id, api_key, opts)
  return data
end

#public_api_delete_job_postings_with_http_info(job_id, api_key, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

delete a job posting

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 40

def public_api_delete_job_postings_with_http_info(job_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobPostingsApi.public_api_delete_job_postings ..."
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobPostingsApi.public_api_delete_job_postings"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling JobPostingsApi.public_api_delete_job_postings"
  end
  # resource path
  local_var_path = "/api/pub/v1/jobPostings/{jobId}".sub('{' + 'jobId' + '}', job_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobPostingsApi#public_api_delete_job_postings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_job_posting(job_id, api_key, opts = {}) ⇒ PublicApiGetJobPostingResponse

retrieve a job posting

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 89

def public_api_get_job_posting(job_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_job_posting_with_http_info(job_id, api_key, opts)
  return data
end

#public_api_get_job_posting_with_http_info(job_id, api_key, opts = {}) ⇒ Array<(PublicApiGetJobPostingResponse, Fixnum, Hash)>

retrieve a job posting

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 100

def public_api_get_job_posting_with_http_info(job_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobPostingsApi.public_api_get_job_posting ..."
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobPostingsApi.public_api_get_job_posting"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling JobPostingsApi.public_api_get_job_posting"
  end
  # resource path
  local_var_path = "/api/pub/v1/jobPostings/{jobId}".sub('{' + 'jobId' + '}', job_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PublicApiGetJobPostingResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobPostingsApi#public_api_get_job_posting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_job_postings(api_key, opts = {}) ⇒ PublicApiGetJobPostingListResponse

retrieve a list of all job postings

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer) —

    skip number of records, default 0

  • :take (Integer) —

    retrieve x amount of records, limit 500, default 50

Returns:



150
151
152
153
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 150

def public_api_get_job_postings(api_key, opts = {})
  data, _status_code, _headers = public_api_get_job_postings_with_http_info(api_key, opts)
  return data
end

#public_api_get_job_postings_with_http_info(api_key, opts = {}) ⇒ Array<(PublicApiGetJobPostingListResponse, Fixnum, Hash)>

retrieve a list of all job postings

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer) —

    skip number of records, default 0

  • :take (Integer) —

    retrieve x amount of records, limit 500, default 50

Returns:



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 162

def public_api_get_job_postings_with_http_info(api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobPostingsApi.public_api_get_job_postings ..."
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling JobPostingsApi.public_api_get_job_postings"
  end
  # resource path
  local_var_path = "/api/pub/v1/jobPostings"

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PublicApiGetJobPostingListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobPostingsApi#public_api_get_job_postings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_recent_job_postings(api_key, modified, opts = {}) ⇒ PublicApiGetJobPostingListResponse

retrieve a list of job postings updated within a certain time frame

Parameters:

  • api_key —

    crelate api key

  • modified —

    modified within x number of minutes ago

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer) —

    skip number of records, default 0

  • :take (Integer) —

    retrieve x amount of records, limit 500, default 50

Returns:



211
212
213
214
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 211

def public_api_get_recent_job_postings(api_key, modified, opts = {})
  data, _status_code, _headers = public_api_get_recent_job_postings_with_http_info(api_key, modified, opts)
  return data
end

#public_api_get_recent_job_postings_with_http_info(api_key, modified, opts = {}) ⇒ Array<(PublicApiGetJobPostingListResponse, Fixnum, Hash)>

retrieve a list of job postings updated within a certain time frame

Parameters:

  • api_key —

    crelate api key

  • modified —

    modified within x number of minutes ago

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer) —

    skip number of records, default 0

  • :take (Integer) —

    retrieve x amount of records, limit 500, default 50

Returns:



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
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 224

def public_api_get_recent_job_postings_with_http_info(api_key, modified, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobPostingsApi.public_api_get_recent_job_postings ..."
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling JobPostingsApi.public_api_get_recent_job_postings"
  end
  # verify the required parameter 'modified' is set
  if @api_client.config.client_side_validation && modified.nil?
    fail ArgumentError, "Missing the required parameter 'modified' when calling JobPostingsApi.public_api_get_recent_job_postings"
  end
  # resource path
  local_var_path = "/api/pub/v1/jobPostings/recent"

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key
  query_params[:'modified'] = modified
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PublicApiGetJobPostingListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobPostingsApi#public_api_get_recent_job_postings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_post_job_posting_application(job_id, api_key, request, opts = {}) ⇒ PublicApiIdResponse

create a job application The ResumeContent field should contain a Base64 encoded string representing the contents of the resume, the ResumeFilename should be the original resume filename including the extension.

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



277
278
279
280
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 277

def public_api_post_job_posting_application(job_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_post_job_posting_application_with_http_info(job_id, api_key, request, opts)
  return data
end

#public_api_post_job_posting_application_with_http_info(job_id, api_key, request, opts = {}) ⇒ Array<(PublicApiIdResponse, Fixnum, Hash)>

create a job application The ResumeContent field should contain a Base64 encoded string representing the contents of the resume, the ResumeFilename should be the original resume filename including the extension.

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Array<(PublicApiIdResponse, Fixnum, Hash)>) —

    PublicApiIdResponse 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/crelate_client/api/job_postings_api.rb', line 289

def public_api_post_job_posting_application_with_http_info(job_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobPostingsApi.public_api_post_job_posting_application ..."
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobPostingsApi.public_api_post_job_posting_application"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling JobPostingsApi.public_api_post_job_posting_application"
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling JobPostingsApi.public_api_post_job_posting_application"
  end
  # resource path
  local_var_path = "/api/pub/v1/jobPostings/{jobId}/applications".sub('{' + 'jobId' + '}', job_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  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 => 'PublicApiIdResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobPostingsApi#public_api_post_job_posting_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_put_job_posting(api_key, query, opts = {}) ⇒ PublicApiGetJobPostingSearchResponse

search job postings

Parameters:

  • api_key —

    crelate api key

  • query —

    search terms

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

    the optional parameters

Returns:



344
345
346
347
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 344

def public_api_put_job_posting(api_key, query, opts = {})
  data, _status_code, _headers = public_api_put_job_posting_with_http_info(api_key, query, opts)
  return data
end

#public_api_put_job_posting_0(job_id, api_key, request, opts = {}) ⇒ Object

update a job posting Replaces all fields. To partially update a job, first retrieve it using the GET method, apply changes and submit to the PUT method.

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


406
407
408
409
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 406

def public_api_put_job_posting_0(job_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_put_job_posting_0_with_http_info(job_id, api_key, request, opts)
  return data
end

#public_api_put_job_posting_0_with_http_info(job_id, api_key, request, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

update a job posting Replaces all fields. To partially update a job, first retrieve it using the GET method, apply changes and submit to the PUT method.

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 418

def public_api_put_job_posting_0_with_http_info(job_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobPostingsApi.public_api_put_job_posting_0 ..."
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobPostingsApi.public_api_put_job_posting_0"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling JobPostingsApi.public_api_put_job_posting_0"
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling JobPostingsApi.public_api_put_job_posting_0"
  end
  # resource path
  local_var_path = "/api/pub/v1/jobPostings/{jobId}".sub('{' + 'jobId' + '}', job_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobPostingsApi#public_api_put_job_posting_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_put_job_posting_with_http_info(api_key, query, opts = {}) ⇒ Array<(PublicApiGetJobPostingSearchResponse, Fixnum, Hash)>

search job postings

Parameters:

  • api_key —

    crelate api key

  • query —

    search terms

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

    the optional parameters

Returns:



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/crelate_client/api/job_postings_api.rb', line 355

def public_api_put_job_posting_with_http_info(api_key, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobPostingsApi.public_api_put_job_posting ..."
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling JobPostingsApi.public_api_put_job_posting"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling JobPostingsApi.public_api_put_job_posting"
  end
  # resource path
  local_var_path = "/api/pub/v1/jobPostings/search"

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key
  query_params[:'query'] = query

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PublicApiGetJobPostingSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobPostingsApi#public_api_put_job_posting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end