Class: CrelateClient::ContactsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContactsApi

Returns a new instance of ContactsApi.



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

def api_client
  @api_client
end

Instance Method Details

#public_api_delete_contact(contact_id, api_key, opts = {}) ⇒ Object

delete a contact

Parameters:

  • contact_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/contacts_api.rb', line 29

def public_api_delete_contact(contact_id, api_key, opts = {})
  data, _status_code, _headers = public_api_delete_contact_with_http_info(contact_id, api_key, opts)
  return data
end

#public_api_delete_contact_attachment(contact_id, attachment_id, api_key, opts = {}) ⇒ Object

delete an attachment for a contact

Parameters:

  • contact_id —

    contact identifier

  • attachment_id —

    attachment identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


90
91
92
93
 
# File 'lib/crelate_client/api/contacts_api.rb', line 90

def public_api_delete_contact_attachment(contact_id, attachment_id, api_key, opts = {})
  data, _status_code, _headers = public_api_delete_contact_attachment_with_http_info(contact_id, attachment_id, api_key, opts)
  return data
end

#public_api_delete_contact_attachment_with_http_info(contact_id, attachment_id, api_key, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

delete an attachment for a contact

Parameters:

  • contact_id —

    contact identifier

  • attachment_id —

    attachment 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



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
142
143
144
145
146
147
 
# File 'lib/crelate_client/api/contacts_api.rb', line 102

def public_api_delete_contact_attachment_with_http_info(contact_id, attachment_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_delete_contact_attachment ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_delete_contact_attachment"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling ContactsApi.public_api_delete_contact_attachment"
  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 ContactsApi.public_api_delete_contact_attachment"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/attachments/{attachmentId}".sub('{' + 'contactId' + '}', contact_id.to_s).sub('{' + 'attachmentId' + '}', attachment_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: ContactsApi#public_api_delete_contact_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

delete a contact from a job for the recruiting workflow

Parameters:

  • contact_id
  • job_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


156
157
158
159
 
# File 'lib/crelate_client/api/contacts_api.rb', line 156

def public_api_delete_contact_job(contact_id, job_id, api_key, opts = {})
  data, _status_code, _headers = public_api_delete_contact_job_with_http_info(contact_id, job_id, api_key, opts)
  return data
end

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

delete a contact from a job for the recruiting workflow

Parameters:

  • contact_id
  • job_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



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
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/crelate_client/api/contacts_api.rb', line 168

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

#public_api_delete_contact_note(contact_id, note_id, api_key, opts = {}) ⇒ Object

delete a note for a contact

Parameters:

  • contact_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


222
223
224
225
 
# File 'lib/crelate_client/api/contacts_api.rb', line 222

def public_api_delete_contact_note(contact_id, note_id, api_key, opts = {})
  data, _status_code, _headers = public_api_delete_contact_note_with_http_info(contact_id, note_id, api_key, opts)
  return data
end

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

delete a note for a contact

Parameters:

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



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
275
276
277
278
279
 
# File 'lib/crelate_client/api/contacts_api.rb', line 234

def public_api_delete_contact_note_with_http_info(contact_id, note_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_delete_contact_note ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_delete_contact_note"
  end
  # verify the required parameter 'note_id' is set
  if @api_client.config.client_side_validation && note_id.nil?
    fail ArgumentError, "Missing the required parameter 'note_id' when calling ContactsApi.public_api_delete_contact_note"
  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 ContactsApi.public_api_delete_contact_note"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/notes/{noteId}".sub('{' + 'contactId' + '}', contact_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: ContactsApi#public_api_delete_contact_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_delete_contact_task(contact_id, task_id, api_key, opts = {}) ⇒ Object

delete a task for a contact

Parameters:

  • contact_id —

    identifier

  • task_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


288
289
290
291
 
# File 'lib/crelate_client/api/contacts_api.rb', line 288

def public_api_delete_contact_task(contact_id, task_id, api_key, opts = {})
  data, _status_code, _headers = public_api_delete_contact_task_with_http_info(contact_id, task_id, api_key, opts)
  return data
end

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

delete a task for a contact

Parameters:

  • contact_id —

    identifier

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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/crelate_client/api/contacts_api.rb', line 300

def public_api_delete_contact_task_with_http_info(contact_id, task_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_delete_contact_task ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_delete_contact_task"
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling ContactsApi.public_api_delete_contact_task"
  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 ContactsApi.public_api_delete_contact_task"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/tasks/{taskId}".sub('{' + 'contactId' + '}', contact_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: ContactsApi#public_api_delete_contact_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

delete a contact

Parameters:

  • contact_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/contacts_api.rb', line 40

def public_api_delete_contact_with_http_info(contact_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_delete_contact ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_delete_contact"
  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 ContactsApi.public_api_delete_contact"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}".sub('{' + 'contactId' + '}', contact_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: ContactsApi#public_api_delete_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_contact(contact_id, api_key, opts = {}) ⇒ PublicApiGetContactResponse

retrieve a contact by id

Parameters:

  • contact_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



353
354
355
356
 
# File 'lib/crelate_client/api/contacts_api.rb', line 353

def public_api_get_contact(contact_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_contact_with_http_info(contact_id, api_key, opts)
  return data
end

#public_api_get_contact_attachment(contact_id, attachment_id, api_key, opts = {}) ⇒ Object

get the content of a specific attachment for a contact

Parameters:

  • contact_id —

    identifier

  • attachment_id —

    attachment identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


414
415
416
417
 
# File 'lib/crelate_client/api/contacts_api.rb', line 414

def public_api_get_contact_attachment(contact_id, attachment_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_contact_attachment_with_http_info(contact_id, attachment_id, api_key, opts)
  return data
end

#public_api_get_contact_attachment_with_http_info(contact_id, attachment_id, api_key, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

get the content of a specific attachment for a contact

Parameters:

  • contact_id —

    identifier

  • attachment_id —

    attachment 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



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
466
467
468
469
470
471
 
# File 'lib/crelate_client/api/contacts_api.rb', line 426

def public_api_get_contact_attachment_with_http_info(contact_id, attachment_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_get_contact_attachment ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_get_contact_attachment"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling ContactsApi.public_api_get_contact_attachment"
  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 ContactsApi.public_api_get_contact_attachment"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/attachments/{attachmentId}".sub('{' + 'contactId' + '}', contact_id.to_s).sub('{' + 'attachmentId' + '}', attachment_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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#public_api_get_contact_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_contact_attachments(contact_id, api_key, opts = {}) ⇒ PublicApiAttachmentResponseList

get all attachment metadata for a contact

Parameters:

  • contact_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:



479
480
481
482
 
# File 'lib/crelate_client/api/contacts_api.rb', line 479

def public_api_get_contact_attachments(contact_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_contact_attachments_with_http_info(contact_id, api_key, opts)
  return data
end

#public_api_get_contact_attachments_with_http_info(contact_id, api_key, opts = {}) ⇒ Array<(PublicApiAttachmentResponseList, Fixnum, Hash)>

get all attachment metadata for a contact

Parameters:

  • contact_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:



490
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
529
530
531
 
# File 'lib/crelate_client/api/contacts_api.rb', line 490

def public_api_get_contact_attachments_with_http_info(contact_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_get_contact_attachments ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_get_contact_attachments"
  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 ContactsApi.public_api_get_contact_attachments"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/attachments".sub('{' + 'contactId' + '}', contact_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 => 'PublicApiAttachmentResponseList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#public_api_get_contact_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_contact_jobs(contact_id, api_key, opts = {}) ⇒ Array<PublicApiGetContactJob>

get jobs for a contact

Parameters:

  • contact_id —

    contact identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



539
540
541
542
 
# File 'lib/crelate_client/api/contacts_api.rb', line 539

def public_api_get_contact_jobs(contact_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_contact_jobs_with_http_info(contact_id, api_key, opts)
  return data
end

#public_api_get_contact_jobs_with_http_info(contact_id, api_key, opts = {}) ⇒ Array<(Array<PublicApiGetContactJob>, Fixnum, Hash)>

get jobs for a contact

Parameters:

  • contact_id —

    contact identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

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

    Array<PublicApiGetContactJob> data, response status code and response headers



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
585
586
587
588
589
590
591
 
# File 'lib/crelate_client/api/contacts_api.rb', line 550

def public_api_get_contact_jobs_with_http_info(contact_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_get_contact_jobs ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_get_contact_jobs"
  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 ContactsApi.public_api_get_contact_jobs"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/jobs".sub('{' + 'contactId' + '}', contact_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 => 'Array<PublicApiGetContactJob>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#public_api_get_contact_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_contact_note(contact_id, note_id, api_key, opts = {}) ⇒ PublicApiGetNoteResponse

get a note for a contact

Parameters:

  • contact_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:



600
601
602
603
 
# File 'lib/crelate_client/api/contacts_api.rb', line 600

def public_api_get_contact_note(contact_id, note_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_contact_note_with_http_info(contact_id, note_id, api_key, opts)
  return data
end

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

get a note for a contact

Parameters:

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



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
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/crelate_client/api/contacts_api.rb', line 612

def public_api_get_contact_note_with_http_info(contact_id, note_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_get_contact_note ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_get_contact_note"
  end
  # verify the required parameter 'note_id' is set
  if @api_client.config.client_side_validation && note_id.nil?
    fail ArgumentError, "Missing the required parameter 'note_id' when calling ContactsApi.public_api_get_contact_note"
  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 ContactsApi.public_api_get_contact_note"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/notes/{noteId}".sub('{' + 'contactId' + '}', contact_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: ContactsApi#public_api_get_contact_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_contact_placements(contact_id, api_key, opts = {}) ⇒ PublicApiPlacementResponseList

Get placements associated with a job Please Note: TimeToFill is the amount of Days it took to fill the position

Parameters:

  • contact_id —

    id for job

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



667
668
669
670
 
# File 'lib/crelate_client/api/contacts_api.rb', line 667

def public_api_get_contact_placements(contact_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_contact_placements_with_http_info(contact_id, api_key, opts)
  return data
end

#public_api_get_contact_placements_with_http_info(contact_id, api_key, opts = {}) ⇒ Array<(PublicApiPlacementResponseList, Fixnum, Hash)>

Get placements associated with a job Please Note: TimeToFill is the amount of Days it took to fill the position

Parameters:

  • contact_id —

    id for job

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



680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
 
# File 'lib/crelate_client/api/contacts_api.rb', line 680

def public_api_get_contact_placements_with_http_info(contact_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_get_contact_placements ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_get_contact_placements"
  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 ContactsApi.public_api_get_contact_placements"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/placements".sub('{' + 'contactId' + '}', contact_id.to_s)

  # 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 => 'PublicApiPlacementResponseList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#public_api_get_contact_placements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_contact_task(contact_id, task_id, api_key, opts = {}) ⇒ PublicApiGetTaskResponse

get a task for a contact

Parameters:

  • contact_id —

    identifier

  • task_id —

    task identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



732
733
734
735
 
# File 'lib/crelate_client/api/contacts_api.rb', line 732

def public_api_get_contact_task(contact_id, task_id, api_key, opts = {})
  data, _status_code, _headers = public_api_get_contact_task_with_http_info(contact_id, task_id, api_key, opts)
  return data
end

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

get a task for a contact

Parameters:

  • contact_id —

    identifier

  • task_id —

    task 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



744
745
746
747
748
749
750
751
752
753
754
755
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
 
# File 'lib/crelate_client/api/contacts_api.rb', line 744

def public_api_get_contact_task_with_http_info(contact_id, task_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_get_contact_task ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_get_contact_task"
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling ContactsApi.public_api_get_contact_task"
  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 ContactsApi.public_api_get_contact_task"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/tasks/{taskId}".sub('{' + 'contactId' + '}', contact_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: ContactsApi#public_api_get_contact_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_contact_with_http_info(contact_id, api_key, opts = {}) ⇒ Array<(PublicApiGetContactResponse, Fixnum, Hash)>

retrieve a contact by id

Parameters:

  • contact_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



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

def public_api_get_contact_with_http_info(contact_id, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_get_contact ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_get_contact"
  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 ContactsApi.public_api_get_contact"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}".sub('{' + 'contactId' + '}', contact_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 => 'PublicApiGetContactResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#public_api_get_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_contacts(modified, api_key, opts = {}) ⇒ PublicApiGetContactResponseList

retrieve a list of contact updated within a certain time frame

Parameters:

  • modified —

    modified within x number of minutes

  • 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

  • :type (String) —

    filter by record type, acceptable options are null, 0, 1, 2, 3, 4, 5, 6, 7 defaults to 0, 0 &#x3D; All contacts regardless of record type null &#x3D; contacts without a record type Standard: 1 &#x3D; Candidate, 2 &#x3D; Sales Client Contact, 4 &#x3D; Lead Contact Combined: 3 &#x3D; 1 and 2, 5 &#x3D; 1 and 4, 6 &#x3D; 2 and 4, 7 &#x3D; 1 and 2 and 4] e.g. type 7 will select only contacts who are all three types

Returns:



800
801
802
803
 
# File 'lib/crelate_client/api/contacts_api.rb', line 800

def public_api_get_contacts(modified, api_key, opts = {})
  data, _status_code, _headers = public_api_get_contacts_with_http_info(modified, api_key, opts)
  return data
end

#public_api_get_contacts_by_email(email, api_key, opts = {}) ⇒ PublicApiGetContactResponseList

retrieve a list of contacts by email

Parameters:

  • email —

    email address

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



867
868
869
870
 
# File 'lib/crelate_client/api/contacts_api.rb', line 867

def public_api_get_contacts_by_email(email, api_key, opts = {})
  data, _status_code, _headers = public_api_get_contacts_by_email_with_http_info(email, api_key, opts)
  return data
end

#public_api_get_contacts_by_email_with_http_info(email, api_key, opts = {}) ⇒ Array<(PublicApiGetContactResponseList, Fixnum, Hash)>

retrieve a list of contacts by email

Parameters:

  • email —

    email address

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



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
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/crelate_client/api/contacts_api.rb', line 878

def public_api_get_contacts_by_email_with_http_info(email, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_get_contacts_by_email ..."
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.public_api_get_contacts_by_email"
  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 ContactsApi.public_api_get_contacts_by_email"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts"

  # query parameters
  query_params = {}
  query_params[:'email'] = email
  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 => 'PublicApiGetContactResponseList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#public_api_get_contacts_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

retrieve a list of contact updated within a certain time frame

Parameters:

  • modified —

    modified within x number of minutes

  • 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

  • :type (String) —

    filter by record type, acceptable options are null, 0, 1, 2, 3, 4, 5, 6, 7 defaults to 0, 0 &#x3D; All contacts regardless of record type null &#x3D; contacts without a record type Standard: 1 &#x3D; Candidate, 2 &#x3D; Sales Client Contact, 4 &#x3D; Lead Contact Combined: 3 &#x3D; 1 and 2, 5 &#x3D; 1 and 4, 6 &#x3D; 2 and 4, 7 &#x3D; 1 and 2 and 4] e.g. type 7 will select only contacts who are all three types

Returns:



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
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/crelate_client/api/contacts_api.rb', line 814

def public_api_get_contacts_with_http_info(modified, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_get_contacts ..."
  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 ContactsApi.public_api_get_contacts"
  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 ContactsApi.public_api_get_contacts"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/recent"

  # query parameters
  query_params = {}
  query_params[:'modified'] = modified
  query_params[:'api_key'] = api_key
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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 => 'PublicApiGetContactResponseList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#public_api_get_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

create a contact

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



928
929
930
931
 
# File 'lib/crelate_client/api/contacts_api.rb', line 928

def public_api_post_contact(api_key, request, opts = {})
  data, _status_code, _headers = public_api_post_contact_with_http_info(api_key, request, opts)
  return data
end

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

add an attachment to a contact

Parameters:

  • contact_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



991
992
993
994
 
# File 'lib/crelate_client/api/contacts_api.rb', line 991

def public_api_post_contact_attachment(contact_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_post_contact_attachment_with_http_info(contact_id, api_key, request, opts)
  return data
end

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

add an attachment to a contact

Parameters:

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



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1003

def public_api_post_contact_attachment_with_http_info(contact_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_post_contact_attachment ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_post_contact_attachment"
  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 ContactsApi.public_api_post_contact_attachment"
  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 ContactsApi.public_api_post_contact_attachment"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/attachments".sub('{' + 'contactId' + '}', contact_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: ContactsApi#public_api_post_contact_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

move a contact into a job for the first time

Parameters:

  • contact_id —

    identifier

  • job_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



1060
1061
1062
1063
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1060

def public_api_post_contact_job(contact_id, job_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_post_contact_job_with_http_info(contact_id, job_id, api_key, request, opts)
  return data
end

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

move a contact into a job for the first time

Parameters:

  • contact_id —

    identifier

  • 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



1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
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
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1073

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

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

create a note for a contact

Parameters:

  • contact_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



1133
1134
1135
1136
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1133

def public_api_post_contact_note(contact_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_post_contact_note_with_http_info(contact_id, api_key, request, opts)
  return data
end

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

create a note for a contact

Parameters:

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



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
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
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1145

def public_api_post_contact_note_with_http_info(contact_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_post_contact_note ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_post_contact_note"
  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 ContactsApi.public_api_post_contact_note"
  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 ContactsApi.public_api_post_contact_note"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/notes".sub('{' + 'contactId' + '}', contact_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: ContactsApi#public_api_post_contact_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

save a task for a contact

Parameters:

  • contact_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



1201
1202
1203
1204
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1201

def public_api_post_contact_task(contact_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_post_contact_task_with_http_info(contact_id, api_key, request, opts)
  return data
end

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

save a task for a contact

Parameters:

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



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1213

def public_api_post_contact_task_with_http_info(contact_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_post_contact_task ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_post_contact_task"
  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 ContactsApi.public_api_post_contact_task"
  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 ContactsApi.public_api_post_contact_task"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}/tasks".sub('{' + 'contactId' + '}', contact_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: ContactsApi#public_api_post_contact_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

create a contact

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



939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/crelate_client/api/contacts_api.rb', line 939

def public_api_post_contact_with_http_info(api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_post_contact ..."
  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 ContactsApi.public_api_post_contact"
  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 ContactsApi.public_api_post_contact"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts"

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

#public_api_put_contact(contact_id, api_key, request, opts = {}) ⇒ Object

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

Parameters:

  • contact_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


1269
1270
1271
1272
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1269

def public_api_put_contact(contact_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_put_contact_with_http_info(contact_id, api_key, request, opts)
  return data
end

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

update job stage for a contact

Parameters:

  • contact_id —

    contact identifier

  • job_id —

    job identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


1338
1339
1340
1341
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1338

def public_api_put_contact_job_status(contact_id, job_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_put_contact_job_status_with_http_info(contact_id, job_id, api_key, request, opts)
  return data
end

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

update job stage for a contact

Parameters:

  • contact_id —

    contact identifier

  • job_id —

    job 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



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
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
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1351

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

#public_api_put_contact_note(contact_id, note_id, api_key, request, opts = {}) ⇒ Object

update a note for a contact

Parameters:

  • contact_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


1412
1413
1414
1415
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1412

def public_api_put_contact_note(contact_id, note_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_put_contact_note_with_http_info(contact_id, note_id, api_key, request, opts)
  return data
end

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

update a note for a contact

Parameters:

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



1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
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
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1425

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

#public_api_put_contact_task(contact_id, task_id, api_key, request, opts = {}) ⇒ Object

update a task for a contact

Parameters:

  • contact_id —

    identifier

  • task_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


1486
1487
1488
1489
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1486

def public_api_put_contact_task(contact_id, task_id, api_key, request, opts = {})
  data, _status_code, _headers = public_api_put_contact_task_with_http_info(contact_id, task_id, api_key, request, opts)
  return data
end

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

update a task for a contact

Parameters:

  • contact_id —

    identifier

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



1499
1500
1501
1502
1503
1504
1505
1506
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
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1499

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

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

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

Parameters:

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



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/crelate_client/api/contacts_api.rb', line 1281

def public_api_put_contact_with_http_info(contact_id, api_key, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContactsApi.public_api_put_contact ..."
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactsApi.public_api_put_contact"
  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 ContactsApi.public_api_put_contact"
  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 ContactsApi.public_api_put_contact"
  end
  # resource path
  local_var_path = "/api/pub/v1/contacts/{contactId}".sub('{' + 'contactId' + '}', contact_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: ContactsApi#public_api_put_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end