Class: PureCloud::ExternalContactsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/external_contacts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExternalContactsApi

Returns a new instance of ExternalContactsApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_externalcontacts_contact(contact_id, opts = {}) ⇒ Empty

Delete an external contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 32

def delete_externalcontacts_contact(contact_id, opts = {})
  data, _status_code, _headers = delete_externalcontacts_contact_with_http_info(contact_id, opts)
  return data
end

#delete_externalcontacts_contact_note(contact_id, note_id, opts = {}) ⇒ Empty

Delete a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 98

def delete_externalcontacts_contact_note(contact_id, note_id, opts = {})
  data, _status_code, _headers = delete_externalcontacts_contact_note_with_http_info(contact_id, note_id, opts)
  return data
end

#delete_externalcontacts_contact_note_with_http_info(contact_id, note_id, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 109

def delete_externalcontacts_contact_note_with_http_info(contact_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.delete_externalcontacts_contact_note ..."
  end
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling ExternalContactsApi.delete_externalcontacts_contact_note" if contact_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'note_id' is set
  fail ArgumentError, "Missing the required parameter 'note_id' when calling ExternalContactsApi.delete_externalcontacts_contact_note" if note_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}".sub('{format}','json').sub('{' + 'contactId' + '}', contact_id.to_s).sub('{' + 'noteId' + '}', note_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#delete_externalcontacts_contact_with_http_info(contact_id, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete an external contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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

def delete_externalcontacts_contact_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.delete_externalcontacts_contact ..."
  end
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling ExternalContactsApi.delete_externalcontacts_contact" if contact_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#delete_externalcontacts_contacts_schema(schema_id, opts = {}) ⇒ nil

Delete a schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:

  • (nil) 


172
173
174
175
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 172

def delete_externalcontacts_contacts_schema(schema_id, opts = {})
  delete_externalcontacts_contacts_schema_with_http_info(schema_id, opts)
  return nil
end

#delete_externalcontacts_contacts_schema_with_http_info(schema_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 182

def delete_externalcontacts_contacts_schema_with_http_info(schema_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.delete_externalcontacts_contacts_schema ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling ExternalContactsApi.delete_externalcontacts_contacts_schema" if schema_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/schemas/{schemaId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#delete_externalcontacts_organization(external_organization_id, opts = {}) ⇒ Empty

Delete an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Returns:



236
237
238
239
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 236

def delete_externalcontacts_organization(external_organization_id, opts = {})
  data, _status_code, _headers = delete_externalcontacts_organization_with_http_info(external_organization_id, opts)
  return data
end

#delete_externalcontacts_organization_note(external_organization_id, note_id, opts = {}) ⇒ Empty

Delete a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:



302
303
304
305
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 302

def delete_externalcontacts_organization_note(external_organization_id, note_id, opts = {})
  data, _status_code, _headers = delete_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, opts)
  return data
end

#delete_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 313

def delete_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.delete_externalcontacts_organization_note ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.delete_externalcontacts_organization_note" if external_organization_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'note_id' is set
  fail ArgumentError, "Missing the required parameter 'note_id' when calling ExternalContactsApi.delete_externalcontacts_organization_note" if note_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s).sub('{' + 'noteId' + '}', note_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#delete_externalcontacts_organization_trustor(external_organization_id, opts = {}) ⇒ nil

Unlink the Trustor for this External Organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Returns:

  • (nil) 


376
377
378
379
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 376

def delete_externalcontacts_organization_trustor(external_organization_id, opts = {})
  delete_externalcontacts_organization_trustor_with_http_info(external_organization_id, opts)
  return nil
end

#delete_externalcontacts_organization_trustor_with_http_info(external_organization_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Unlink the Trustor for this External Organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 386

def delete_externalcontacts_organization_trustor_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.delete_externalcontacts_organization_trustor ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.delete_externalcontacts_organization_trustor" if external_organization_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#delete_externalcontacts_organization_with_http_info(external_organization_id, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 246

def delete_externalcontacts_organization_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.delete_externalcontacts_organization ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.delete_externalcontacts_organization" if external_organization_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#delete_externalcontacts_relationship(relationship_id, opts = {}) ⇒ Empty

Delete a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Returns:



440
441
442
443
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 440

def delete_externalcontacts_relationship(relationship_id, opts = {})
  data, _status_code, _headers = delete_externalcontacts_relationship_with_http_info(relationship_id, opts)
  return data
end

#delete_externalcontacts_relationship_with_http_info(relationship_id, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 450

def delete_externalcontacts_relationship_with_http_info(relationship_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.delete_externalcontacts_relationship ..."
  end
  
  
  # verify the required parameter 'relationship_id' is set
  fail ArgumentError, "Missing the required parameter 'relationship_id' when calling ExternalContactsApi.delete_externalcontacts_relationship" if relationship_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/relationships/{relationshipId}".sub('{format}','json').sub('{' + 'relationshipId' + '}', relationship_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_contact(contact_id, opts = {}) ⇒ ExternalContact

Fetch an external contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand (externalOrganization,externalDataSources)

Returns:



506
507
508
509
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 506

def get_externalcontacts_contact(contact_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_contact_with_http_info(contact_id, opts)
  return data
end

#get_externalcontacts_contact_note(contact_id, note_id, opts = {}) ⇒ Note

Fetch a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



581
582
583
584
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 581

def get_externalcontacts_contact_note(contact_id, note_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_contact_note_with_http_info(contact_id, note_id, opts)
  return data
end

#get_externalcontacts_contact_note_with_http_info(contact_id, note_id, opts = {}) ⇒ Array<(Note, Fixnum, Hash)>

Fetch a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    Note data, response status code and response headers



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
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
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 593

def get_externalcontacts_contact_note_with_http_info(contact_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_contact_note ..."
  end
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling ExternalContactsApi.get_externalcontacts_contact_note" if contact_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'note_id' is set
  fail ArgumentError, "Missing the required parameter 'note_id' when calling ExternalContactsApi.get_externalcontacts_contact_note" if note_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}".sub('{format}','json').sub('{' + 'contactId' + '}', contact_id.to_s).sub('{' + 'noteId' + '}', note_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_contact_notes(contact_id, opts = {}) ⇒ NoteListing

List notes for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



667
668
669
670
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 667

def get_externalcontacts_contact_notes(contact_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_contact_notes_with_http_info(contact_id, opts)
  return data
end

#get_externalcontacts_contact_notes_with_http_info(contact_id, opts = {}) ⇒ Array<(NoteListing, Fixnum, Hash)>

List notes for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    NoteListing data, response status code and response headers



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
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 681

def get_externalcontacts_contact_notes_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_contact_notes ..."
  end
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling ExternalContactsApi.get_externalcontacts_contact_notes" if contact_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/{contactId}/notes".sub('{format}','json').sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_contact_with_http_info(contact_id, opts = {}) ⇒ Array<(ExternalContact, Fixnum, Hash)>

Fetch an external contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand (externalOrganization,externalDataSources)

Returns:

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

    ExternalContact data, response status code and response headers



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 517

def get_externalcontacts_contact_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_contact ..."
  end
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling ExternalContactsApi.get_externalcontacts_contact" if contact_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_contacts(opts = {}) ⇒ ContactListing

Search for external contacts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)

  • :q (String) —

    User supplied search keywords (no special syntax is currently supported)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



768
769
770
771
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 768

def get_externalcontacts_contacts(opts = {})
  data, _status_code, _headers = get_externalcontacts_contacts_with_http_info(opts)
  return data
end

#get_externalcontacts_contacts_schema(schema_id, opts = {}) ⇒ DataSchema

Get a schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:



864
865
866
867
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 864

def get_externalcontacts_contacts_schema(schema_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_contacts_schema_with_http_info(schema_id, opts)
  return data
end

#get_externalcontacts_contacts_schema_version(schema_id, version_id, opts = {}) ⇒ DataSchema

Get a specific version of a schema

Parameters:

  • schema_id —

    Schema ID

  • version_id —

    Schema version

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

    the optional parameters

Returns:



930
931
932
933
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 930

def get_externalcontacts_contacts_schema_version(schema_id, version_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_contacts_schema_version_with_http_info(schema_id, version_id, opts)
  return data
end

#get_externalcontacts_contacts_schema_version_with_http_info(schema_id, version_id, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Get a specific version of a schema

Parameters:

  • schema_id —

    Schema ID

  • version_id —

    Schema version

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



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
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 941

def get_externalcontacts_contacts_schema_version_with_http_info(schema_id, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_contacts_schema_version ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling ExternalContactsApi.get_externalcontacts_contacts_schema_version" if schema_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling ExternalContactsApi.get_externalcontacts_contacts_schema_version" if version_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_contacts_schema_versions(schema_id, opts = {}) ⇒ DataSchema

Get all versions of an external contact’s schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:



1004
1005
1006
1007
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1004

def get_externalcontacts_contacts_schema_versions(schema_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_contacts_schema_versions_with_http_info(schema_id, opts)
  return data
end

#get_externalcontacts_contacts_schema_versions_with_http_info(schema_id, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Get all versions of an external contact&#39;s schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



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
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1014

def get_externalcontacts_contacts_schema_versions_with_http_info(schema_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_contacts_schema_versions ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling ExternalContactsApi.get_externalcontacts_contacts_schema_versions" if schema_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_contacts_schema_with_http_info(schema_id, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Get a schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



874
875
876
877
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
921
922
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 874

def get_externalcontacts_contacts_schema_with_http_info(schema_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_contacts_schema ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling ExternalContactsApi.get_externalcontacts_contacts_schema" if schema_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/schemas/{schemaId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_contacts_schemas(opts = {}) ⇒ DataSchemaListing

Get a list of schemas.

Parameters:

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

    the optional parameters

Returns:



1068
1069
1070
1071
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1068

def get_externalcontacts_contacts_schemas(opts = {})
  data, _status_code, _headers = get_externalcontacts_contacts_schemas_with_http_info(opts)
  return data
end

#get_externalcontacts_contacts_schemas_with_http_info(opts = {}) ⇒ Array<(DataSchemaListing, Fixnum, Hash)>

Get a list of schemas.

Parameters:

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

    the optional parameters

Returns:

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

    DataSchemaListing data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1077

def get_externalcontacts_contacts_schemas_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_contacts_schemas ..."
  end
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/schemas".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_contacts_with_http_info(opts = {}) ⇒ Array<(ContactListing, Fixnum, Hash)>

Search for external contacts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :q (String) —

    User supplied search keywords (no special syntax is currently supported)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    ContactListing data, response status code and response headers



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
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
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 782

def get_externalcontacts_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_contacts ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'q'] = opts[:'q'] if opts[:'q']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organization(external_organization_id, opts = {}) ⇒ ExternalOrganization

Fetch an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    which fields, if any, to expand (externalDataSources)

  • :include_trustors (BOOLEAN) — default: true or false —

    whether or not to include trustor information embedded in the externalOrganization

Returns:



1126
1127
1128
1129
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1126

def get_externalcontacts_organization(external_organization_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_organization_with_http_info(external_organization_id, opts)
  return data
end

#get_externalcontacts_organization_contacts(external_organization_id, opts = {}) ⇒ ContactListing

Search for external contacts in an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)

  • :q (String) —

    User supplied search keywords (no special syntax is currently supported)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



1216
1217
1218
1219
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1216

def get_externalcontacts_organization_contacts(external_organization_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_organization_contacts_with_http_info(external_organization_id, opts)
  return data
end

#get_externalcontacts_organization_contacts_with_http_info(external_organization_id, opts = {}) ⇒ Array<(ContactListing, Fixnum, Hash)>

Search for external contacts in an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :q (String) —

    User supplied search keywords (no special syntax is currently supported)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    ContactListing data, response status code and response headers



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
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
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
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1231

def get_externalcontacts_organization_contacts_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organization_contacts ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.get_externalcontacts_organization_contacts" if external_organization_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'q'] = opts[:'q'] if opts[:'q']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organization_note(external_organization_id, note_id, opts = {}) ⇒ Note

Fetch a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



1323
1324
1325
1326
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1323

def get_externalcontacts_organization_note(external_organization_id, note_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, opts)
  return data
end

#get_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, opts = {}) ⇒ Array<(Note, Fixnum, Hash)>

Fetch a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    Note data, response status code and response headers



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
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
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1335

def get_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organization_note ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.get_externalcontacts_organization_note" if external_organization_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'note_id' is set
  fail ArgumentError, "Missing the required parameter 'note_id' when calling ExternalContactsApi.get_externalcontacts_organization_note" if note_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s).sub('{' + 'noteId' + '}', note_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organization_notes(external_organization_id, opts = {}) ⇒ NoteListing

List notes for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



1409
1410
1411
1412
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1409

def get_externalcontacts_organization_notes(external_organization_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_organization_notes_with_http_info(external_organization_id, opts)
  return data
end

#get_externalcontacts_organization_notes_with_http_info(external_organization_id, opts = {}) ⇒ Array<(NoteListing, Fixnum, Hash)>

List notes for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    NoteListing data, response status code and response headers



1423
1424
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
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1423

def get_externalcontacts_organization_notes_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organization_notes ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.get_externalcontacts_organization_notes" if external_organization_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organization_relationships(external_organization_id, opts = {}) ⇒ RelationshipListing

Fetch a relationship for an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)

  • :expand (String) —

    which fields, if any, to expand

  • :sort_order (String) —

    Sort order

Returns:



1510
1511
1512
1513
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1510

def get_externalcontacts_organization_relationships(external_organization_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_organization_relationships_with_http_info(external_organization_id, opts)
  return data
end

#get_externalcontacts_organization_relationships_with_http_info(external_organization_id, opts = {}) ⇒ Array<(RelationshipListing, Fixnum, Hash)>

Fetch a relationship for an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :expand (String) —

    which fields, if any, to expand

  • :sort_order (String) —

    Sort order

Returns:

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

    RelationshipListing data, response status code and response headers



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
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1524

def get_externalcontacts_organization_relationships_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organization_relationships ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.get_externalcontacts_organization_relationships" if external_organization_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['externalDataSources'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of externalDataSources'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organization_with_http_info(external_organization_id, opts = {}) ⇒ Array<(ExternalOrganization, Fixnum, Hash)>

Fetch an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    which fields, if any, to expand (externalDataSources)

  • :include_trustors (BOOLEAN) — default: true or false —

    whether or not to include trustor information embedded in the externalOrganization

Returns:

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

    ExternalOrganization data, response status code and response headers



1138
1139
1140
1141
1142
1143
1144
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
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1138

def get_externalcontacts_organization_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organization ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.get_externalcontacts_organization" if external_organization_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['externalDataSources'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of externalDataSources'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'includeTrustors'] = opts[:'include_trustors'] if opts[:'include_trustors']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organizations(opts = {}) ⇒ ExternalOrganizationListing

Search for external organizations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)

  • :q (String) —

    Search query

  • :trustor_id (Array<String>) —

    Search for external organizations by trustorIds (limit 25). If supplied, the &#39;q&#39; parameters is ignored. Items are returned in the order requested

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

  • :include_trustors (BOOLEAN) — default: true or false —

    whether or not to include trustor information embedded in the externalOrganization

Returns:



1617
1618
1619
1620
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1617

def get_externalcontacts_organizations(opts = {})
  data, _status_code, _headers = get_externalcontacts_organizations_with_http_info(opts)
  return data
end

#get_externalcontacts_organizations_schema(schema_id, opts = {}) ⇒ DataSchema

Get a schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:



1729
1730
1731
1732
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1729

def get_externalcontacts_organizations_schema(schema_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_organizations_schema_with_http_info(schema_id, opts)
  return data
end

#get_externalcontacts_organizations_schema_version(schema_id, version_id, opts = {}) ⇒ DataSchema

Get a specific version of a schema

Parameters:

  • schema_id —

    Schema ID

  • version_id —

    Schema version

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

    the optional parameters

Returns:



1795
1796
1797
1798
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1795

def get_externalcontacts_organizations_schema_version(schema_id, version_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_organizations_schema_version_with_http_info(schema_id, version_id, opts)
  return data
end

#get_externalcontacts_organizations_schema_version_with_http_info(schema_id, version_id, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Get a specific version of a schema

Parameters:

  • schema_id —

    Schema ID

  • version_id —

    Schema version

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1806

def get_externalcontacts_organizations_schema_version_with_http_info(schema_id, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organizations_schema_version ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling ExternalContactsApi.get_externalcontacts_organizations_schema_version" if schema_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling ExternalContactsApi.get_externalcontacts_organizations_schema_version" if version_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organizations_schema_versions(schema_id, opts = {}) ⇒ DataSchema

Get all versions of an external organization’s schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:



1869
1870
1871
1872
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1869

def get_externalcontacts_organizations_schema_versions(schema_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_organizations_schema_versions_with_http_info(schema_id, opts)
  return data
end

#get_externalcontacts_organizations_schema_versions_with_http_info(schema_id, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Get all versions of an external organization&#39;s schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1879

def get_externalcontacts_organizations_schema_versions_with_http_info(schema_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organizations_schema_versions ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling ExternalContactsApi.get_externalcontacts_organizations_schema_versions" if schema_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organizations_schema_with_http_info(schema_id, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Get a schema

Parameters:

  • schema_id —

    Schema ID

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1739

def get_externalcontacts_organizations_schema_with_http_info(schema_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organizations_schema ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling ExternalContactsApi.get_externalcontacts_organizations_schema" if schema_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/schemas/{schemaId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organizations_schemas(opts = {}) ⇒ DataSchemaListing

Get a list of schemas.

Parameters:

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

    the optional parameters

Returns:



1933
1934
1935
1936
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1933

def get_externalcontacts_organizations_schemas(opts = {})
  data, _status_code, _headers = get_externalcontacts_organizations_schemas_with_http_info(opts)
  return data
end

#get_externalcontacts_organizations_schemas_with_http_info(opts = {}) ⇒ Array<(DataSchemaListing, Fixnum, Hash)>

Get a list of schemas.

Parameters:

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

    the optional parameters

Returns:

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

    DataSchemaListing data, response status code and response headers



1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1942

def get_externalcontacts_organizations_schemas_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organizations_schemas ..."
  end
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/schemas".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_organizations_with_http_info(opts = {}) ⇒ Array<(ExternalOrganizationListing, Fixnum, Hash)>

Search for external organizations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :page_number (Integer) —

    Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)

  • :q (String) —

    Search query

  • :trustor_id (Array<String>) —

    Search for external organizations by trustorIds (limit 25). If supplied, the &#39;q&#39; parameters is ignored. Items are returned in the order requested

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

  • :include_trustors (BOOLEAN) — default: true or false —

    whether or not to include trustor information embedded in the externalOrganization

Returns:



1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1633

def get_externalcontacts_organizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organizations ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'q'] = opts[:'q'] if opts[:'q']
  query_params[:'trustorId'] = @api_client.build_collection_param(opts[:'trustor_id'], :multi) if opts[:'trustor_id']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'includeTrustors'] = opts[:'include_trustors'] if opts[:'include_trustors']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_relationship(relationship_id, opts = {}) ⇒ Relationship

Fetch a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    which fields, if any, to expand

Returns:



1990
1991
1992
1993
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1990

def get_externalcontacts_relationship(relationship_id, opts = {})
  data, _status_code, _headers = get_externalcontacts_relationship_with_http_info(relationship_id, opts)
  return data
end

#get_externalcontacts_relationship_with_http_info(relationship_id, opts = {}) ⇒ Array<(Relationship, Fixnum, Hash)>

Fetch a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    which fields, if any, to expand

Returns:

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

    Relationship data, response status code and response headers



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2001

def get_externalcontacts_relationship_with_http_info(relationship_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_relationship ..."
  end
  
  
  # verify the required parameter 'relationship_id' is set
  fail ArgumentError, "Missing the required parameter 'relationship_id' when calling ExternalContactsApi.get_externalcontacts_relationship" if relationship_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['externalDataSources'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of externalDataSources'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/relationships/{relationshipId}".sub('{format}','json').sub('{' + 'relationshipId' + '}', relationship_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_reversewhitepageslookup(lookup_val, opts = {}) ⇒ ReverseWhitepagesLookupResult

Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.

Parameters:

  • lookup_val —

    User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which field, if any, to expand

Returns:



2068
2069
2070
2071
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2068

def get_externalcontacts_reversewhitepageslookup(lookup_val, opts = {})
  data, _status_code, _headers = get_externalcontacts_reversewhitepageslookup_with_http_info(lookup_val, opts)
  return data
end

#get_externalcontacts_reversewhitepageslookup_with_http_info(lookup_val, opts = {}) ⇒ Array<(ReverseWhitepagesLookupResult, Fixnum, Hash)>

Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.

Parameters:

  • lookup_val —

    User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which field, if any, to expand

Returns:



2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2079

def get_externalcontacts_reversewhitepageslookup_with_http_info(lookup_val, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_reversewhitepageslookup ..."
  end
  
  
  # verify the required parameter 'lookup_val' is set
  fail ArgumentError, "Missing the required parameter 'lookup_val' when calling ExternalContactsApi.get_externalcontacts_reversewhitepageslookup" if lookup_val.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/reversewhitepageslookup".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'lookupVal'] = lookup_val
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_scan_contacts(opts = {}) ⇒ CursorContactListing

Scan for external contacts using paging

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of contacts per page; must be between 10 and 200, default is 100)

  • :cursor (String) —

    Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL

Returns:



2143
2144
2145
2146
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2143

def get_externalcontacts_scan_contacts(opts = {})
  data, _status_code, _headers = get_externalcontacts_scan_contacts_with_http_info(opts)
  return data
end

#get_externalcontacts_scan_contacts_with_http_info(opts = {}) ⇒ Array<(CursorContactListing, Fixnum, Hash)>

Scan for external contacts using paging

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of contacts per page; must be between 10 and 200, default is 100)

  • :cursor (String) —

    Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL

Returns:

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

    CursorContactListing data, response status code and response headers



2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2154

def get_externalcontacts_scan_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_scan_contacts ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/scan/contacts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_scan_notes(opts = {}) ⇒ CursorNoteListing

Scan for notes using paging

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of notes per page; must be between 10 and 200, default is 100)

  • :cursor (String) —

    Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL

Returns:



2216
2217
2218
2219
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2216

def get_externalcontacts_scan_notes(opts = {})
  data, _status_code, _headers = get_externalcontacts_scan_notes_with_http_info(opts)
  return data
end

#get_externalcontacts_scan_notes_with_http_info(opts = {}) ⇒ Array<(CursorNoteListing, Fixnum, Hash)>

Scan for notes using paging

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of notes per page; must be between 10 and 200, default is 100)

  • :cursor (String) —

    Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL

Returns:

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

    CursorNoteListing data, response status code and response headers



2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2227

def get_externalcontacts_scan_notes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_scan_notes ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/scan/notes".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_scan_organizations(opts = {}) ⇒ CursorOrganizationListing

Scan for external organizations using paging

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of organizations per page; must be between 10 and 200, default is 100)

  • :cursor (String) —

    Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL

Returns:



2289
2290
2291
2292
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2289

def get_externalcontacts_scan_organizations(opts = {})
  data, _status_code, _headers = get_externalcontacts_scan_organizations_with_http_info(opts)
  return data
end

#get_externalcontacts_scan_organizations_with_http_info(opts = {}) ⇒ Array<(CursorOrganizationListing, Fixnum, Hash)>

Scan for external organizations using paging

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of organizations per page; must be between 10 and 200, default is 100)

  • :cursor (String) —

    Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL

Returns:

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

    CursorOrganizationListing data, response status code and response headers



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2300

def get_externalcontacts_scan_organizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_scan_organizations ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/scan/organizations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_externalcontacts_scan_relationships(opts = {}) ⇒ CursorRelationshipListing

Scan for relationships

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of relationships per page; must be between 10 and 200, default is 100)

  • :cursor (String) —

    Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL

Returns:



2362
2363
2364
2365
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2362

def get_externalcontacts_scan_relationships(opts = {})
  data, _status_code, _headers = get_externalcontacts_scan_relationships_with_http_info(opts)
  return data
end

#get_externalcontacts_scan_relationships_with_http_info(opts = {}) ⇒ Array<(CursorRelationshipListing, Fixnum, Hash)>

Scan for relationships

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of relationships per page; must be between 10 and 200, default is 100)

  • :cursor (String) —

    Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL

Returns:

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

    CursorRelationshipListing data, response status code and response headers



2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2373

def get_externalcontacts_scan_relationships_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_scan_relationships ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/scan/relationships".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_externalcontacts_contact_notes(contact_id, body, opts = {}) ⇒ Note

Create a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • body —

    ExternalContact

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

    the optional parameters

Returns:



2435
2436
2437
2438
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2435

def post_externalcontacts_contact_notes(contact_id, body, opts = {})
  data, _status_code, _headers = post_externalcontacts_contact_notes_with_http_info(contact_id, body, opts)
  return data
end

#post_externalcontacts_contact_notes_with_http_info(contact_id, body, opts = {}) ⇒ Array<(Note, Fixnum, Hash)>

Create a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • body —

    ExternalContact

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

    the optional parameters

Returns:

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

    Note data, response status code and response headers



2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2446

def post_externalcontacts_contact_notes_with_http_info(contact_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_contact_notes ..."
  end
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling ExternalContactsApi.post_externalcontacts_contact_notes" if contact_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.post_externalcontacts_contact_notes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/{contactId}/notes".sub('{format}','json').sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_externalcontacts_contacts(body, opts = {}) ⇒ ExternalContact

Create an external contact

Parameters:

  • body —

    ExternalContact

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

    the optional parameters

Returns:



2509
2510
2511
2512
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2509

def post_externalcontacts_contacts(body, opts = {})
  data, _status_code, _headers = post_externalcontacts_contacts_with_http_info(body, opts)
  return data
end

#post_externalcontacts_contacts_schemas(body, opts = {}) ⇒ DataSchema

Create a schema

Parameters:

  • body —

    Schema

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

    the optional parameters

Returns:



2574
2575
2576
2577
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2574

def post_externalcontacts_contacts_schemas(body, opts = {})
  data, _status_code, _headers = post_externalcontacts_contacts_schemas_with_http_info(body, opts)
  return data
end

#post_externalcontacts_contacts_schemas_with_http_info(body, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Create a schema

Parameters:

  • body —

    Schema

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2584

def post_externalcontacts_contacts_schemas_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_contacts_schemas ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.post_externalcontacts_contacts_schemas" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/schemas".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_externalcontacts_contacts_with_http_info(body, opts = {}) ⇒ Array<(ExternalContact, Fixnum, Hash)>

Create an external contact

Parameters:

  • body —

    ExternalContact

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

    the optional parameters

Returns:

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

    ExternalContact data, response status code and response headers



2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2519

def post_externalcontacts_contacts_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_contacts ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.post_externalcontacts_contacts" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_externalcontacts_organization_notes(external_organization_id, body, opts = {}) ⇒ Note

Create a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • body —

    ExternalContact

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

    the optional parameters

Returns:



2640
2641
2642
2643
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2640

def post_externalcontacts_organization_notes(external_organization_id, body, opts = {})
  data, _status_code, _headers = post_externalcontacts_organization_notes_with_http_info(external_organization_id, body, opts)
  return data
end

#post_externalcontacts_organization_notes_with_http_info(external_organization_id, body, opts = {}) ⇒ Array<(Note, Fixnum, Hash)>

Create a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • body —

    ExternalContact

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

    the optional parameters

Returns:

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

    Note data, response status code and response headers



2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2651

def post_externalcontacts_organization_notes_with_http_info(external_organization_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_organization_notes ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.post_externalcontacts_organization_notes" if external_organization_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.post_externalcontacts_organization_notes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_externalcontacts_organizations(body, opts = {}) ⇒ ExternalOrganization

Create an external organization

Parameters:

  • body —

    ExternalOrganization

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

    the optional parameters

Returns:



2714
2715
2716
2717
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2714

def post_externalcontacts_organizations(body, opts = {})
  data, _status_code, _headers = post_externalcontacts_organizations_with_http_info(body, opts)
  return data
end

#post_externalcontacts_organizations_schemas(body, opts = {}) ⇒ DataSchema

Create a schema

Parameters:

  • body —

    Schema

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

    the optional parameters

Returns:



2779
2780
2781
2782
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2779

def post_externalcontacts_organizations_schemas(body, opts = {})
  data, _status_code, _headers = post_externalcontacts_organizations_schemas_with_http_info(body, opts)
  return data
end

#post_externalcontacts_organizations_schemas_with_http_info(body, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Create a schema

Parameters:

  • body —

    Schema

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2789

def post_externalcontacts_organizations_schemas_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_organizations_schemas ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.post_externalcontacts_organizations_schemas" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/schemas".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_externalcontacts_organizations_with_http_info(body, opts = {}) ⇒ Array<(ExternalOrganization, Fixnum, Hash)>

Create an external organization

Parameters:

  • body —

    ExternalOrganization

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

    the optional parameters

Returns:

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

    ExternalOrganization data, response status code and response headers



2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2724

def post_externalcontacts_organizations_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_organizations ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.post_externalcontacts_organizations" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_externalcontacts_relationships(body, opts = {}) ⇒ Relationship

Create a relationship

Parameters:

  • body —

    Relationship

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

    the optional parameters

Returns:



2844
2845
2846
2847
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2844

def post_externalcontacts_relationships(body, opts = {})
  data, _status_code, _headers = post_externalcontacts_relationships_with_http_info(body, opts)
  return data
end

#post_externalcontacts_relationships_with_http_info(body, opts = {}) ⇒ Array<(Relationship, Fixnum, Hash)>

Create a relationship

Parameters:

  • body —

    Relationship

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

    the optional parameters

Returns:

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

    Relationship data, response status code and response headers



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2854

def post_externalcontacts_relationships_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_relationships ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.post_externalcontacts_relationships" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/relationships".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#put_externalcontacts_contact(contact_id, body, opts = {}) ⇒ ExternalContact

Update an external contact

Parameters:

  • contact_id —

    ExternalContact ID

  • body —

    ExternalContact

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

    the optional parameters

Returns:



2910
2911
2912
2913
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2910

def put_externalcontacts_contact(contact_id, body, opts = {})
  data, _status_code, _headers = put_externalcontacts_contact_with_http_info(contact_id, body, opts)
  return data
end

#put_externalcontacts_contact_note(contact_id, note_id, body, opts = {}) ⇒ Note

Update a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

  • body —

    Note

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

    the optional parameters

Returns:



2986
2987
2988
2989
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2986

def put_externalcontacts_contact_note(contact_id, note_id, body, opts = {})
  data, _status_code, _headers = put_externalcontacts_contact_note_with_http_info(contact_id, note_id, body, opts)
  return data
end

#put_externalcontacts_contact_note_with_http_info(contact_id, note_id, body, opts = {}) ⇒ Array<(Note, Fixnum, Hash)>

Update a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

  • body —

    Note

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

    the optional parameters

Returns:

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

    Note data, response status code and response headers



2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2998

def put_externalcontacts_contact_note_with_http_info(contact_id, note_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_contact_note ..."
  end
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling ExternalContactsApi.put_externalcontacts_contact_note" if contact_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'note_id' is set
  fail ArgumentError, "Missing the required parameter 'note_id' when calling ExternalContactsApi.put_externalcontacts_contact_note" if note_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_contact_note" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}".sub('{format}','json').sub('{' + 'contactId' + '}', contact_id.to_s).sub('{' + 'noteId' + '}', note_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#put_externalcontacts_contact_with_http_info(contact_id, body, opts = {}) ⇒ Array<(ExternalContact, Fixnum, Hash)>

Update an external contact

Parameters:

  • contact_id —

    ExternalContact ID

  • body —

    ExternalContact

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

    the optional parameters

Returns:

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

    ExternalContact data, response status code and response headers



2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 2921

def put_externalcontacts_contact_with_http_info(contact_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_contact ..."
  end
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling ExternalContactsApi.put_externalcontacts_contact" if contact_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_contact" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#put_externalcontacts_contacts_schema(schema_id, body, opts = {}) ⇒ DataSchema

Update a schema

Parameters:

  • schema_id —

    Schema ID

  • body —

    Data Schema

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

    the optional parameters

Returns:



3070
3071
3072
3073
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3070

def put_externalcontacts_contacts_schema(schema_id, body, opts = {})
  data, _status_code, _headers = put_externalcontacts_contacts_schema_with_http_info(schema_id, body, opts)
  return data
end

#put_externalcontacts_contacts_schema_with_http_info(schema_id, body, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Update a schema

Parameters:

  • schema_id —

    Schema ID

  • body —

    Data Schema

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3081

def put_externalcontacts_contacts_schema_with_http_info(schema_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_contacts_schema ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling ExternalContactsApi.put_externalcontacts_contacts_schema" if schema_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_contacts_schema" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/contacts/schemas/{schemaId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#put_externalcontacts_conversation(body, conversation_id, opts = {}) ⇒ nil

Associate/disassociate an external contact with a conversation To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.

Parameters:

  • body —

    ConversationAssociation

  • conversation_id —

    Conversation ID

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

    the optional parameters

Returns:

  • (nil) 


3145
3146
3147
3148
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3145

def put_externalcontacts_conversation(body, conversation_id, opts = {})
  put_externalcontacts_conversation_with_http_info(body, conversation_id, opts)
  return nil
end

#put_externalcontacts_conversation_with_http_info(body, conversation_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Associate/disassociate an external contact with a conversation To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.

Parameters:

  • body —

    ConversationAssociation

  • conversation_id —

    Conversation ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3156

def put_externalcontacts_conversation_with_http_info(body, conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_conversation ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_conversation" if body.nil?
  
  
  
  
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ExternalContactsApi.put_externalcontacts_conversation" if conversation_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/conversations/{conversationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#put_externalcontacts_organization(external_organization_id, body, opts = {}) ⇒ ExternalOrganization

Update an external organization

Parameters:

  • external_organization_id —

    External Organization ID

  • body —

    ExternalOrganization

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

    the optional parameters

Returns:



3219
3220
3221
3222
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3219

def put_externalcontacts_organization(external_organization_id, body, opts = {})
  data, _status_code, _headers = put_externalcontacts_organization_with_http_info(external_organization_id, body, opts)
  return data
end

#put_externalcontacts_organization_note(external_organization_id, note_id, body, opts = {}) ⇒ Note

Update a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

  • body —

    Note

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

    the optional parameters

Returns:



3295
3296
3297
3298
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3295

def put_externalcontacts_organization_note(external_organization_id, note_id, body, opts = {})
  data, _status_code, _headers = put_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, body, opts)
  return data
end

#put_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, body, opts = {}) ⇒ Array<(Note, Fixnum, Hash)>

Update a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

  • body —

    Note

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

    the optional parameters

Returns:

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

    Note data, response status code and response headers



3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3307

def put_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_organization_note ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.put_externalcontacts_organization_note" if external_organization_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'note_id' is set
  fail ArgumentError, "Missing the required parameter 'note_id' when calling ExternalContactsApi.put_externalcontacts_organization_note" if note_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_organization_note" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s).sub('{' + 'noteId' + '}', note_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#put_externalcontacts_organization_trustor_trustor_id(external_organization_id, trustor_id, opts = {}) ⇒ ExternalOrganizationTrustorLink

Links a Trustor with an External Organization

Parameters:

  • external_organization_id —

    External Organization ID

  • trustor_id —

    Trustor ID

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

    the optional parameters

Returns:



3379
3380
3381
3382
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3379

def put_externalcontacts_organization_trustor_trustor_id(external_organization_id, trustor_id, opts = {})
  data, _status_code, _headers = put_externalcontacts_organization_trustor_trustor_id_with_http_info(external_organization_id, trustor_id, opts)
  return data
end

#put_externalcontacts_organization_trustor_trustor_id_with_http_info(external_organization_id, trustor_id, opts = {}) ⇒ Array<(ExternalOrganizationTrustorLink, Fixnum, Hash)>

Links a Trustor with an External Organization

Parameters:

  • external_organization_id —

    External Organization ID

  • trustor_id —

    Trustor ID

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

    the optional parameters

Returns:



3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3390

def put_externalcontacts_organization_trustor_trustor_id_with_http_info(external_organization_id, trustor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_organization_trustor_trustor_id ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.put_externalcontacts_organization_trustor_trustor_id" if external_organization_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'trustor_id' is set
  fail ArgumentError, "Missing the required parameter 'trustor_id' when calling ExternalContactsApi.put_externalcontacts_organization_trustor_trustor_id" if trustor_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s).sub('{' + 'trustorId' + '}', trustor_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#put_externalcontacts_organization_with_http_info(external_organization_id, body, opts = {}) ⇒ Array<(ExternalOrganization, Fixnum, Hash)>

Update an external organization

Parameters:

  • external_organization_id —

    External Organization ID

  • body —

    ExternalOrganization

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

    the optional parameters

Returns:

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

    ExternalOrganization data, response status code and response headers



3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3230

def put_externalcontacts_organization_with_http_info(external_organization_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_organization ..."
  end
  
  
  # verify the required parameter 'external_organization_id' is set
  fail ArgumentError, "Missing the required parameter 'external_organization_id' when calling ExternalContactsApi.put_externalcontacts_organization" if external_organization_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_organization" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/{externalOrganizationId}".sub('{format}','json').sub('{' + 'externalOrganizationId' + '}', external_organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#put_externalcontacts_organizations_schema(schema_id, body, opts = {}) ⇒ DataSchema

Update a schema

Parameters:

  • schema_id —

    Schema ID

  • body —

    Data Schema

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

    the optional parameters

Returns:



3454
3455
3456
3457
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3454

def put_externalcontacts_organizations_schema(schema_id, body, opts = {})
  data, _status_code, _headers = put_externalcontacts_organizations_schema_with_http_info(schema_id, body, opts)
  return data
end

#put_externalcontacts_organizations_schema_with_http_info(schema_id, body, opts = {}) ⇒ Array<(DataSchema, Fixnum, Hash)>

Update a schema

Parameters:

  • schema_id —

    Schema ID

  • body —

    Data Schema

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

    the optional parameters

Returns:

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

    DataSchema data, response status code and response headers



3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3465

def put_externalcontacts_organizations_schema_with_http_info(schema_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_organizations_schema ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling ExternalContactsApi.put_externalcontacts_organizations_schema" if schema_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_organizations_schema" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations/schemas/{schemaId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#put_externalcontacts_relationship(relationship_id, body, opts = {}) ⇒ Relationship

Update a relationship

Parameters:

  • relationship_id —

    Relationship Id

  • body —

    Relationship

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

    the optional parameters

Returns:



3529
3530
3531
3532
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3529

def put_externalcontacts_relationship(relationship_id, body, opts = {})
  data, _status_code, _headers = put_externalcontacts_relationship_with_http_info(relationship_id, body, opts)
  return data
end

#put_externalcontacts_relationship_with_http_info(relationship_id, body, opts = {}) ⇒ Array<(Relationship, Fixnum, Hash)>

Update a relationship

Parameters:

  • relationship_id —

    Relationship Id

  • body —

    Relationship

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

    the optional parameters

Returns:

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

    Relationship data, response status code and response headers



3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 3540

def put_externalcontacts_relationship_with_http_info(relationship_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.put_externalcontacts_relationship ..."
  end
  
  
  # verify the required parameter 'relationship_id' is set
  fail ArgumentError, "Missing the required parameter 'relationship_id' when calling ExternalContactsApi.put_externalcontacts_relationship" if relationship_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ExternalContactsApi.put_externalcontacts_relationship" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/externalcontacts/relationships/{relationshipId}".sub('{format}','json').sub('{' + 'relationshipId' + '}', relationship_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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