Class: CrelateClient::CompaniesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CompaniesApi

Returns a new instance of CompaniesApi.



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

def api_client
  @api_client
end

Instance Method Details

#public_api_delete_account(company_id, api_key, opts = {}) ⇒ Object

delete a company

Parameters:

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

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

#public_api_delete_account_attachment(company_id, attachment_id, api_key, opts = {}) ⇒ Object

delete an attachment for a company

Parameters:

  • company_id —

    job 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/companies_api.rb', line 90

def (company_id, attachment_id, api_key, opts = {})
  data, _status_code, _headers = (company_id, attachment_id, api_key, opts)
  return data
end

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

delete an attachment for a company

Parameters:

  • company_id —

    job 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/companies_api.rb', line 102

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

#public_api_delete_account_note(company_id, note_id, api_key, opts = {}) ⇒ Object

delete a note for a company

Parameters:

  • company_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


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

def (company_id, note_id, api_key, opts = {})
  data, _status_code, _headers = (company_id, note_id, api_key, opts)
  return data
end

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

delete a note for a company

Parameters:

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



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/companies_api.rb', line 168

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

#public_api_delete_account_task(company_id, task_id, api_key, opts = {}) ⇒ Object

delete a task for a company

Parameters:

  • company_id —

    identifier

  • task_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


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

def (company_id, task_id, api_key, opts = {})
  data, _status_code, _headers = (company_id, task_id, api_key, opts)
  return data
end

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

delete a task for a company

Parameters:

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



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/companies_api.rb', line 234

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

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

delete a company

Parameters:

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

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

#public_api_get_account(company_id, api_key, opts = {}) ⇒ PublicApiGetAccountResponse

retrieve a company

Parameters:

  • company_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



287
288
289
290
 
# File 'lib/crelate_client/api/companies_api.rb', line 287

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

#public_api_get_account_attachment(company_id, attachment_id, api_key, opts = {}) ⇒ Object

get the content of a specific attachment for a company

Parameters:

  • company_id —

    identifier

  • attachment_id —

    attachment identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


348
349
350
351
 
# File 'lib/crelate_client/api/companies_api.rb', line 348

def (company_id, attachment_id, api_key, opts = {})
  data, _status_code, _headers = (company_id, attachment_id, api_key, opts)
  return data
end

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

get the content of a specific attachment for a company

Parameters:

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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/crelate_client/api/companies_api.rb', line 360

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

#public_api_get_account_attachments(company_id, api_key, opts = {}) ⇒ PublicApiAttachmentResponseList

get all attachment metadata for a company

Parameters:

  • company_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:



413
414
415
416
 
# File 'lib/crelate_client/api/companies_api.rb', line 413

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

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

get all attachment metadata for a company

Parameters:

  • company_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:



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

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

#public_api_get_account_note(company_id, note_id, api_key, opts = {}) ⇒ PublicApiGetNoteResponse

retrieve a note for a company

Parameters:

  • company_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:



474
475
476
477
 
# File 'lib/crelate_client/api/companies_api.rb', line 474

def (company_id, note_id, api_key, opts = {})
  data, _status_code, _headers = (company_id, note_id, api_key, opts)
  return data
end

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

retrieve a note for a company

Parameters:

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



486
487
488
489
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/companies_api.rb', line 486

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

#public_api_get_account_task(company_id, task_id, api_key, opts = {}) ⇒ PublicApiGetTaskResponse

get a task for a company

Parameters:

  • company_id —

    identifier

  • task_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:



540
541
542
543
 
# File 'lib/crelate_client/api/companies_api.rb', line 540

def (company_id, task_id, api_key, opts = {})
  data, _status_code, _headers = (company_id, task_id, api_key, opts)
  return data
end

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

get a task for a company

Parameters:

  • company_id —

    identifier

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



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
592
593
594
595
596
597
 
# File 'lib/crelate_client/api/companies_api.rb', line 552

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

#public_api_get_account_with_http_info(company_id, api_key, opts = {}) ⇒ Array<(PublicApiGetAccountResponse, Fixnum, Hash)>

retrieve a company

Parameters:

  • company_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



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

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

#public_api_get_accounts(modified, api_key, opts = {}) ⇒ PublicApiGetAccountResponseList

retrieve a list of companies 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; Customer, 2 &#x3D; Potential Customer, Combined: 3 &#x3D; Customer and Potential Customer e.g. type 7 will select only contacts who are all three types

Returns:



608
609
610
611
 
# File 'lib/crelate_client/api/companies_api.rb', line 608

def public_api_get_accounts(modified, api_key, opts = {})
  data, _status_code, _headers = public_api_get_accounts_with_http_info(modified, api_key, opts)
  return data
end

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

retrieve a list of companies 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; Customer, 2 &#x3D; Potential Customer, Combined: 3 &#x3D; Customer and Potential Customer e.g. type 7 will select only contacts who are all three types

Returns:



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
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/crelate_client/api/companies_api.rb', line 622

def public_api_get_accounts_with_http_info(modified, api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompaniesApi.public_api_get_accounts ..."
  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 CompaniesApi.public_api_get_accounts"
  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 CompaniesApi.public_api_get_accounts"
  end
  # resource path
  local_var_path = "/api/pub/v1/companies/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 => 'PublicApiGetAccountResponseList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompaniesApi#public_api_get_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

create a company

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



675
676
677
678
 
# File 'lib/crelate_client/api/companies_api.rb', line 675

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

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

add an attachment to a company

Parameters:

  • company_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



738
739
740
741
 
# File 'lib/crelate_client/api/companies_api.rb', line 738

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

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

add an attachment to a company

Parameters:

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



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
790
791
792
793
794
795
796
797
 
# File 'lib/crelate_client/api/companies_api.rb', line 750

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

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

create a note for a company

Parameters:

  • company_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



806
807
808
809
 
# File 'lib/crelate_client/api/companies_api.rb', line 806

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

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

create a note for a company

Parameters:

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



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
860
861
862
863
864
865
 
# File 'lib/crelate_client/api/companies_api.rb', line 818

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

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

create a task for a company

Parameters:

  • company_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



874
875
876
877
 
# File 'lib/crelate_client/api/companies_api.rb', line 874

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

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

create a task for a company

Parameters:

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



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
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'lib/crelate_client/api/companies_api.rb', line 886

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

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

create a company

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



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
724
725
726
727
728
729
 
# File 'lib/crelate_client/api/companies_api.rb', line 686

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

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

#public_api_put_account(company_id, api_key, request, opts = {}) ⇒ Object

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

Parameters:

  • company_id —

    identifier

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


942
943
944
945
 
# File 'lib/crelate_client/api/companies_api.rb', line 942

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

#public_api_put_account_note(company_id, note_id, api_key, request, opts = {}) ⇒ Object

update a note for a company

Parameters:

  • company_id —

    identifier

  • note_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


1011
1012
1013
1014
 
# File 'lib/crelate_client/api/companies_api.rb', line 1011

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

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

update a note for a company

Parameters:

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



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
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
 
# File 'lib/crelate_client/api/companies_api.rb', line 1024

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

#public_api_put_account_task(company_id, task_id, api_key, request, opts = {}) ⇒ Object

update a task for a company

Parameters:

  • company_id —

    identifier

  • task_id
  • api_key —

    crelate api key

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

    the optional parameters

Returns:

  • (Object) 


1085
1086
1087
1088
 
# File 'lib/crelate_client/api/companies_api.rb', line 1085

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

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

update a task for a company

Parameters:

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



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
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/crelate_client/api/companies_api.rb', line 1098

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

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

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

Parameters:

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



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
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/crelate_client/api/companies_api.rb', line 954

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