Class: PureCloud::ExternalContactsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/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.



7
8
9
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#delete_contacts_contact_id(contact_id, opts = {}) ⇒ nil

Delete a contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Returns:

  • (nil) 


272
273
274
275
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 272

def delete_contacts_contact_id(contact_id, opts = {})
  delete_contacts_contact_id_with_http_info(contact_id, opts)
  return nil
end

#delete_contacts_contact_id_notes_note_id(contact_id, note_id, opts = {}) ⇒ nil

Delete a note for a contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

  • (nil) 


600
601
602
603
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 600

def delete_contacts_contact_id_notes_note_id(contact_id, note_id, opts = {})
  delete_contacts_contact_id_notes_note_id_with_http_info(contact_id, note_id, opts)
  return nil
end

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

Delete a note for a contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
657
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 611

def delete_contacts_contact_id_notes_note_id_with_http_info(contact_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#delete_contacts_contact_id_notes_note_id ..."
  end
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling delete_contacts_contact_id_notes_note_id" if contact_id.nil?
  
  # verify the required parameter 'note_id' is set
  fail "Missing the required parameter 'note_id' when calling delete_contacts_contact_id_notes_note_id" if note_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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_contacts_contact_id_notes_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_contacts_contact_id_with_http_info(contact_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 282

def delete_contacts_contact_id_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#delete_contacts_contact_id ..."
  end
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling delete_contacts_contact_id" if contact_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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_contacts_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an External Organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Returns:

  • (nil) 


914
915
916
917
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 914

def delete_organizations_externalorganization_id(external_organization_id, opts = {})
  delete_organizations_externalorganization_id_with_http_info(external_organization_id, opts)
  return nil
end

#delete_organizations_externalorganization_id_notes_note_id(external_organization_id, note_id, opts = {}) ⇒ nil

Delete a note

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

  • (nil) 


1318
1319
1320
1321
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1318

def delete_organizations_externalorganization_id_notes_note_id(external_organization_id, note_id, opts = {})
  delete_organizations_externalorganization_id_notes_note_id_with_http_info(external_organization_id, note_id, opts)
  return nil
end

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

Delete a note

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1329
1330
1331
1332
1333
1334
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
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1329

def delete_organizations_externalorganization_id_notes_note_id_with_http_info(external_organization_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#delete_organizations_externalorganization_id_notes_note_id ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling delete_organizations_externalorganization_id_notes_note_id" if external_organization_id.nil?
  
  # verify the required parameter 'note_id' is set
  fail "Missing the required parameter 'note_id' when calling delete_organizations_externalorganization_id_notes_note_id" if note_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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_organizations_externalorganization_id_notes_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an 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



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 924

def delete_organizations_externalorganization_id_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#delete_organizations_externalorganization_id ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling delete_organizations_externalorganization_id" if external_organization_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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_organizations_externalorganization_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_relationships_relationship_id(relationship_id, opts = {}) ⇒ nil

Delete a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Returns:

  • (nil) 


1634
1635
1636
1637
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1634

def delete_relationships_relationship_id(relationship_id, opts = {})
  delete_relationships_relationship_id_with_http_info(relationship_id, opts)
  return nil
end

#delete_relationships_relationship_id_with_http_info(relationship_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_relationships_relationship_id_with_http_info(relationship_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#delete_relationships_relationship_id ..."
  end
  
  # verify the required parameter 'relationship_id' is set
  fail "Missing the required parameter 'relationship_id' when calling delete_relationships_relationship_id" if relationship_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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_relationships_relationship_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contacts(opts = {}) ⇒ ContactListing

Search for External Contacts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

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



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

def get_contacts(opts = {})
  data, status_code, headers = get_contacts_with_http_info(opts)
  return data
end

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

Fetch a ExternalContact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



146
147
148
149
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 146

def get_contacts_contact_id(contact_id, opts = {})
  data, status_code, headers = get_contacts_contact_id_with_http_info(contact_id, opts)
  return data
end

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

List Notes for an ExternalContact

Parameters:

  • contact_id —

    ExternalContact Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Sort order

Returns:



335
336
337
338
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 335

def get_contacts_contact_id_notes(contact_id, opts = {})
  data, status_code, headers = get_contacts_contact_id_notes_with_http_info(contact_id, opts)
  return data
end

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

Fetch a note for a contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:



466
467
468
469
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 466

def get_contacts_contact_id_notes_note_id(contact_id, note_id, opts = {})
  data, status_code, headers = get_contacts_contact_id_notes_note_id_with_http_info(contact_id, note_id, opts)
  return data
end

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

Fetch a note for a contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

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

    Note data, response status code and response headers



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 477

def get_contacts_contact_id_notes_note_id_with_http_info(contact_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_contacts_contact_id_notes_note_id ..."
  end
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling get_contacts_contact_id_notes_note_id" if contact_id.nil?
  
  # verify the required parameter 'note_id' is set
  fail "Missing the required parameter 'note_id' when calling get_contacts_contact_id_notes_note_id" if note_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_contacts_contact_id_notes_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List Notes for an ExternalContact

Parameters:

  • contact_id —

    ExternalContact Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Sort order

Returns:

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

    NoteListing data, response status code and response headers



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 348

def get_contacts_contact_id_notes_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_contacts_contact_id_notes ..."
  end
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling get_contacts_contact_id_notes" if contact_id.nil?
  
  # resource path
  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']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_contacts_contact_id_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch a ExternalContact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    ExternalContact data, response status code and response headers



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

def get_contacts_contact_id_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_contacts_contact_id ..."
  end
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling get_contacts_contact_id" if contact_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_contacts_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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

  • :page_number (Integer) —

    Page number

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



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

def get_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_contacts ..."
  end
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizations(opts = {}) ⇒ ExternalOrganizationListing

Search for External Organizations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :q (String) —

    Search query

  • :sort_order (String) —

    Sort order

Returns:



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

def get_organizations(opts = {})
  data, status_code, headers = get_organizations_with_http_info(opts)
  return data
end

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

Fetch an External Organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Returns:



790
791
792
793
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 790

def get_organizations_externalorganization_id(external_organization_id, opts = {})
  data, status_code, headers = get_organizations_externalorganization_id_with_http_info(external_organization_id, opts)
  return data
end

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

Search for External Contacts

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

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



979
980
981
982
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 979

def get_organizations_externalorganization_id_contacts(external_organization_id, opts = {})
  data, status_code, headers = get_organizations_externalorganization_id_contacts_with_http_info(external_organization_id, opts)
  return data
end

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

Search for External Contacts

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

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



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 994

def get_organizations_externalorganization_id_contacts_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_organizations_externalorganization_id_contacts ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling get_organizations_externalorganization_id_contacts" if external_organization_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_organizations_externalorganization_id_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizations_externalorganization_id_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

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Sort order

Returns:



1053
1054
1055
1056
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1053

def get_organizations_externalorganization_id_notes(external_organization_id, opts = {})
  data, status_code, headers = get_organizations_externalorganization_id_notes_with_http_info(external_organization_id, opts)
  return data
end

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

Fetch a note

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:



1184
1185
1186
1187
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1184

def get_organizations_externalorganization_id_notes_note_id(external_organization_id, note_id, opts = {})
  data, status_code, headers = get_organizations_externalorganization_id_notes_note_id_with_http_info(external_organization_id, note_id, opts)
  return data
end

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

Fetch a note

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

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

    Note data, response status code and response headers



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1195

def get_organizations_externalorganization_id_notes_note_id_with_http_info(external_organization_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_organizations_externalorganization_id_notes_note_id ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling get_organizations_externalorganization_id_notes_note_id" if external_organization_id.nil?
  
  # verify the required parameter 'note_id' is set
  fail "Missing the required parameter 'note_id' when calling get_organizations_externalorganization_id_notes_note_id" if note_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_organizations_externalorganization_id_notes_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizations_externalorganization_id_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

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Sort order

Returns:

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

    NoteListing data, response status code and response headers



1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1066

def get_organizations_externalorganization_id_notes_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_organizations_externalorganization_id_notes ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling get_organizations_externalorganization_id_notes" if external_organization_id.nil?
  
  # resource path
  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']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_organizations_externalorganization_id_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch 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

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Sort order

Returns:



1385
1386
1387
1388
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1385

def get_organizations_externalorganization_id_relationships(external_organization_id, opts = {})
  data, status_code, headers = get_organizations_externalorganization_id_relationships_with_http_info(external_organization_id, opts)
  return data
end

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

Fetch 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

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Sort order

Returns:

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

    RelationshipListing data, response status code and response headers



1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1398

def get_organizations_externalorganization_id_relationships_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_organizations_externalorganization_id_relationships ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling get_organizations_externalorganization_id_relationships" if external_organization_id.nil?
  
  # resource path
  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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_organizations_externalorganization_id_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizations_externalorganization_id_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

Returns:

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

    ExternalOrganization data, response status code and response headers



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

def get_organizations_externalorganization_id_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_organizations_externalorganization_id ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling get_organizations_externalorganization_id" if external_organization_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_organizations_externalorganization_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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

  • :page_number (Integer) —

    Page number

  • :q (String) —

    Search query

  • :sort_order (String) —

    Sort order

Returns:



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

def get_organizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_organizations ..."
  end
  
  # resource path
  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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Returns:



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

def get_relationships_relationship_id(relationship_id, opts = {})
  data, status_code, headers = get_relationships_relationship_id_with_http_info(relationship_id, opts)
  return data
end

#get_relationships_relationship_id_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

Returns:

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

    Relationship data, response status code and response headers



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1520

def get_relationships_relationship_id_with_http_info(relationship_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#get_relationships_relationship_id ..."
  end
  
  # verify the required parameter 'relationship_id' is set
  fail "Missing the required parameter 'relationship_id' when calling get_relationships_relationship_id" if relationship_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_relationships_relationship_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_contacts(opts = {}) ⇒ ExternalContact

Create an ExternalContact

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



87
88
89
90
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 87

def post_contacts(opts = {})
  data, status_code, headers = post_contacts_with_http_info(opts)
  return data
end

#post_contacts_contact_id_notes(contact_id, opts = {}) ⇒ Note

Create a Note for an ExternalContact

Parameters:

  • contact_id —

    ExternalContact Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    ExternalContact

Returns:



403
404
405
406
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 403

def post_contacts_contact_id_notes(contact_id, opts = {})
  data, status_code, headers = post_contacts_contact_id_notes_with_http_info(contact_id, opts)
  return data
end

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

Create a Note for an ExternalContact

Parameters:

  • contact_id —

    ExternalContact Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    ExternalContact

Returns:

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

    Note data, response status code and response headers



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 414

def post_contacts_contact_id_notes_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#post_contacts_contact_id_notes ..."
  end
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling post_contacts_contact_id_notes" if contact_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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_contacts_contact_id_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create an ExternalContact

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ExternalContact data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_organizations(opts = {}) ⇒ ExternalOrganization

Create an External Organization

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



732
733
734
735
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 732

def post_organizations(opts = {})
  data, status_code, headers = post_organizations_with_http_info(opts)
  return data
end

#post_organizations_externalorganization_id_notes(external_organization_id, opts = {}) ⇒ Note

Create a Note for an External Organization

Parameters:

  • external_organization_id —

    External Organization Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    ExternalContact

Returns:



1121
1122
1123
1124
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1121

def post_organizations_externalorganization_id_notes(external_organization_id, opts = {})
  data, status_code, headers = post_organizations_externalorganization_id_notes_with_http_info(external_organization_id, opts)
  return data
end

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

Create a Note for an External Organization

Parameters:

  • external_organization_id —

    External Organization Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    ExternalContact

Returns:

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

    Note data, response status code and response headers



1132
1133
1134
1135
1136
1137
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
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1132

def post_organizations_externalorganization_id_notes_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#post_organizations_externalorganization_id_notes ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling post_organizations_externalorganization_id_notes" if external_organization_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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_organizations_externalorganization_id_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create an External Organization

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ExternalOrganization data, response status code and response headers



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 742

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_relationships(opts = {}) ⇒ Relationship

Create a relationship

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1452
1453
1454
1455
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1452

def post_relationships(opts = {})
  data, status_code, headers = post_relationships_with_http_info(opts)
  return data
end

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

Create a relationship

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Relationship data, response status code and response headers



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
1500
1501
1502
1503
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1462

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a externalContact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

Returns:



210
211
212
213
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 210

def put_contacts_contact_id(contact_id, opts = {})
  data, status_code, headers = put_contacts_contact_id_with_http_info(contact_id, opts)
  return data
end

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

Update a note for a contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    Note

Returns:



533
534
535
536
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 533

def put_contacts_contact_id_notes_note_id(contact_id, note_id, opts = {})
  data, status_code, headers = put_contacts_contact_id_notes_note_id_with_http_info(contact_id, note_id, opts)
  return data
end

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

Update a note for a contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    Note

Returns:

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

    Note data, response status code and response headers



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
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 545

def put_contacts_contact_id_notes_note_id_with_http_info(contact_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#put_contacts_contact_id_notes_note_id ..."
  end
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling put_contacts_contact_id_notes_note_id" if contact_id.nil?
  
  # verify the required parameter 'note_id' is set
  fail "Missing the required parameter 'note_id' when calling put_contacts_contact_id_notes_note_id" if note_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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_contacts_contact_id_notes_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a externalContact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ExternalContact data, response status code and response headers



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 221

def put_contacts_contact_id_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#put_contacts_contact_id ..."
  end
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling put_contacts_contact_id" if contact_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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_contacts_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update an External Organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

Returns:



852
853
854
855
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 852

def put_organizations_externalorganization_id(external_organization_id, opts = {})
  data, status_code, headers = put_organizations_externalorganization_id_with_http_info(external_organization_id, opts)
  return data
end

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

Update a note

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    Note

Returns:



1251
1252
1253
1254
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1251

def put_organizations_externalorganization_id_notes_note_id(external_organization_id, note_id, opts = {})
  data, status_code, headers = put_organizations_externalorganization_id_notes_note_id_with_http_info(external_organization_id, note_id, opts)
  return data
end

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

Update a note

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    Note

Returns:

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

    Note data, response status code and response headers



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

def put_organizations_externalorganization_id_notes_note_id_with_http_info(external_organization_id, note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#put_organizations_externalorganization_id_notes_note_id ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling put_organizations_externalorganization_id_notes_note_id" if external_organization_id.nil?
  
  # verify the required parameter 'note_id' is set
  fail "Missing the required parameter 'note_id' when calling put_organizations_externalorganization_id_notes_note_id" if note_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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_organizations_externalorganization_id_notes_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update an External Organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ExternalOrganization data, response status code and response headers



863
864
865
866
867
868
869
870
871
872
873
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
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 863

def put_organizations_externalorganization_id_with_http_info(external_organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#put_organizations_externalorganization_id ..."
  end
  
  # verify the required parameter 'external_organization_id' is set
  fail "Missing the required parameter 'external_organization_id' when calling put_organizations_externalorganization_id" if external_organization_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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_organizations_externalorganization_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Options Hash (opts):

Returns:



1572
1573
1574
1575
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1572

def put_relationships_relationship_id(relationship_id, opts = {})
  data, status_code, headers = put_relationships_relationship_id_with_http_info(relationship_id, opts)
  return data
end

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

Update a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Relationship data, response status code and response headers



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1583

def put_relationships_relationship_id_with_http_info(relationship_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi#put_relationships_relationship_id ..."
  end
  
  # verify the required parameter 'relationship_id' is set
  fail "Missing the required parameter 'relationship_id' when calling put_relationships_relationship_id" if relationship_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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_relationships_relationship_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end