Class: SwaggerClient::JobsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/api/jobs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ JobsApi

Returns a new instance of JobsApi.



19
20
21
 
# File 'lib/swagger_client/api/jobs_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/swagger_client/api/jobs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

delete a job

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


29
30
31
32
 
# File 'lib/swagger_client/api/jobs_api.rb', line 29

def public_api_delete_job(job_id, api_key, opts = {})
  data, _status_code, _headers = public_api_delete_job_with_http_info(job_id, api_key, opts)
  return data
end

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

delete a note for a contact

Parameters:

  • job_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


86
87
88
89
 
# File 'lib/swagger_client/api/jobs_api.rb', line 86

def public_api_delete_job_note(job_id, note_id, api_key, opts = {})
  data, _status_code, _headers = public_api_delete_job_note_with_http_info(job_id, note_id, api_key, opts)
  return data
end

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

delete a note for a contact

Parameters:

  • job_id —

    identifier

  • note_id
  • 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



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

def public_api_delete_job_note_with_http_info(job_id, note_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_delete_job_note ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_delete_job_note" if job_id.nil?
  # verify the required parameter 'note_id' is set
  fail ArgumentError, "Missing the required parameter 'note_id' when calling JobsApi.public_api_delete_job_note" if note_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_delete_job_note" if api_key.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{jobId}/notes/{noteId}".sub('{' + 'jobId' + '}', job_id.to_s).sub('{' + 'noteId' + '}', note_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: JobsApi#public_api_delete_job_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

delete a task for a contact

Parameters:

  • job_id
  • task_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


146
147
148
149
 
# File 'lib/swagger_client/api/jobs_api.rb', line 146

def public_api_delete_job_task(job_id, task_id, api_key, opts = {})
  data, _status_code, _headers = public_api_delete_job_task_with_http_info(job_id, task_id, api_key, opts)
  return data
end

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

delete a task for a contact

Parameters:

  • job_id
  • task_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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/swagger_client/api/jobs_api.rb', line 158

def public_api_delete_job_task_with_http_info(job_id, task_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_delete_job_task ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_delete_job_task" if job_id.nil?
  # verify the required parameter 'task_id' is set
  fail ArgumentError, "Missing the required parameter 'task_id' when calling JobsApi.public_api_delete_job_task" if task_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_delete_job_task" if api_key.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{jobId}/tasks/{taskId}".sub('{' + 'jobId' + '}', job_id.to_s).sub('{' + 'taskId' + '}', task_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: JobsApi#public_api_delete_job_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

delete a job

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
 
# File 'lib/swagger_client/api/jobs_api.rb', line 40

def public_api_delete_job_with_http_info(job_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_delete_job ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_delete_job" if job_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_delete_job" if api_key.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{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: JobsApi#public_api_delete_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_job(job_id, api_key, opts = {}) ⇒ PublicApiGetJobResponse

retrieve a job

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



205
206
207
208
 
# File 'lib/swagger_client/api/jobs_api.rb', line 205

def public_api_get_job(job_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_job_with_http_info(job_id, api_key, opts)
  return data
end

#public_api_get_job_note(job_id, note_id, api_key, opts = {}) ⇒ PublicApiGetNoteResponse

get a note for a contact

Parameters:

  • job_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:



262
263
264
265
 
# File 'lib/swagger_client/api/jobs_api.rb', line 262

def public_api_get_job_note(job_id, note_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_job_note_with_http_info(job_id, note_id, api_key, opts)
  return data
end

#public_api_get_job_note_with_http_info(job_id, note_id, api_key, opts = {}) ⇒ Array<(PublicApiGetNoteResponse, Fixnum, Hash)>

get a note for a contact

Parameters:

  • job_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

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

    PublicApiGetNoteResponse data, response status code and response headers



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/swagger_client/api/jobs_api.rb', line 274

def public_api_get_job_note_with_http_info(job_id, note_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_get_job_note ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_get_job_note" if job_id.nil?
  # verify the required parameter 'note_id' is set
  fail ArgumentError, "Missing the required parameter 'note_id' when calling JobsApi.public_api_get_job_note" if note_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_get_job_note" if api_key.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{jobId}/notes/{noteId}".sub('{' + 'jobId' + '}', job_id.to_s).sub('{' + 'noteId' + '}', note_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 => 'PublicApiGetNoteResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobsApi#public_api_get_job_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_job_task(job_id, task_id, api_key, opts = {}) ⇒ PublicApiGetTaskResponse

get a task for a contact

Parameters:

  • job_id
  • task_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



322
323
324
325
 
# File 'lib/swagger_client/api/jobs_api.rb', line 322

def public_api_get_job_task(job_id, task_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_job_task_with_http_info(job_id, task_id, api_key, opts)
  return data
end

#public_api_get_job_task_with_http_info(job_id, task_id, api_key, opts = {}) ⇒ Array<(PublicApiGetTaskResponse, Fixnum, Hash)>

get a task for a contact

Parameters:

  • job_id
  • task_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

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

    PublicApiGetTaskResponse data, response status code and response headers



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/swagger_client/api/jobs_api.rb', line 334

def public_api_get_job_task_with_http_info(job_id, task_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_get_job_task ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_get_job_task" if job_id.nil?
  # verify the required parameter 'task_id' is set
  fail ArgumentError, "Missing the required parameter 'task_id' when calling JobsApi.public_api_get_job_task" if task_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_get_job_task" if api_key.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{jobId}/tasks/{taskId}".sub('{' + 'jobId' + '}', job_id.to_s).sub('{' + 'taskId' + '}', task_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 => 'PublicApiGetTaskResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobsApi#public_api_get_job_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

retrieve a job

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

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

    PublicApiGetJobResponse data, response status code and response headers



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
 
# File 'lib/swagger_client/api/jobs_api.rb', line 216

def public_api_get_job_with_http_info(job_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_get_job ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_get_job" if job_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_get_job" if api_key.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{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 => 'PublicApiGetJobResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobsApi#public_api_get_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

create a job

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



381
382
383
384
 
# File 'lib/swagger_client/api/jobs_api.rb', line 381

def public_api_post_job(api_key, request, opts = {})
  data, _status_code, _headers = public_api_post_job_with_http_info(api_key, request, opts)
  return data
end

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

create a note for a contact

Parameters:

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



440
441
442
443
 
# File 'lib/swagger_client/api/jobs_api.rb', line 440

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

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

create a note for a contact

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



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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/swagger_client/api/jobs_api.rb', line 452

def public_api_post_job_note_with_http_info(job_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_post_job_note ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_post_job_note" if job_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_post_job_note" if api_key.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling JobsApi.public_api_post_job_note" if request.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{jobId}/notes".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: JobsApi#public_api_post_job_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

create a task for a contact

Parameters:

  • job_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:



502
503
504
505
 
# File 'lib/swagger_client/api/jobs_api.rb', line 502

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

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

create a task for a contact

Parameters:

  • job_id
  • 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



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/swagger_client/api/jobs_api.rb', line 514

def public_api_post_job_task_with_http_info(job_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_post_job_task ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_post_job_task" if job_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_post_job_task" if api_key.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling JobsApi.public_api_post_job_task" if request.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{jobId}/tasks".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: JobsApi#public_api_post_job_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

create a job

Parameters:

  • 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



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
428
429
430
431
 
# File 'lib/swagger_client/api/jobs_api.rb', line 392

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

  # 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: JobsApi#public_api_post_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

update a job 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) 


564
565
566
567
 
# File 'lib/swagger_client/api/jobs_api.rb', line 564

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

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

update a note for a contact

Parameters:

  • job_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


627
628
629
630
 
# File 'lib/swagger_client/api/jobs_api.rb', line 627

def public_api_put_job_note(job_id, note_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_put_job_note_with_http_info(job_id, note_id, api_key, request, opts)
  return data
end

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

update a note for a contact

Parameters:

  • job_id —

    identifier

  • note_id
  • 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



640
641
642
643
644
645
646
647
648
649
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
 
# File 'lib/swagger_client/api/jobs_api.rb', line 640

def public_api_put_job_note_with_http_info(job_id, note_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_put_job_note ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_put_job_note" if job_id.nil?
  # verify the required parameter 'note_id' is set
  fail ArgumentError, "Missing the required parameter 'note_id' when calling JobsApi.public_api_put_job_note" if note_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_put_job_note" if api_key.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling JobsApi.public_api_put_job_note" if request.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{jobId}/notes/{noteId}".sub('{' + 'jobId' + '}', job_id.to_s).sub('{' + 'noteId' + '}', note_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: JobsApi#public_api_put_job_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

update a task for a contact

Parameters:

  • job_id
  • task_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


693
694
695
696
 
# File 'lib/swagger_client/api/jobs_api.rb', line 693

def public_api_put_job_task(job_id, task_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_put_job_task_with_http_info(job_id, task_id, api_key, request, opts)
  return data
end

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

update a task for a contact

Parameters:

  • job_id
  • task_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



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
741
742
743
744
745
746
747
748
749
 
# File 'lib/swagger_client/api/jobs_api.rb', line 706

def public_api_put_job_task_with_http_info(job_id, task_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_put_job_task ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_put_job_task" if job_id.nil?
  # verify the required parameter 'task_id' is set
  fail ArgumentError, "Missing the required parameter 'task_id' when calling JobsApi.public_api_put_job_task" if task_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_put_job_task" if api_key.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling JobsApi.public_api_put_job_task" if request.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{jobId}/tasks/{taskId}".sub('{' + 'jobId' + '}', job_id.to_s).sub('{' + 'taskId' + '}', task_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: JobsApi#public_api_put_job_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

update a job 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



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/swagger_client/api/jobs_api.rb', line 576

def public_api_put_job_with_http_info(job_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobsApi.public_api_put_job ..."
  end
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.public_api_put_job" if job_id.nil?
  # verify the required parameter 'api_key' is set
  fail ArgumentError, "Missing the required parameter 'api_key' when calling JobsApi.public_api_put_job" if api_key.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling JobsApi.public_api_put_job" if request.nil?
  # resource path
  local_var_path = "/api/pub/v1/jobs/{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: JobsApi#public_api_put_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end