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.



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

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) 


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

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) 


92
93
94
95
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 92

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 103

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
  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)
  _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, 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_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



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

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
  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)
  _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, 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_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) 


155
156
157
158
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 155

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) 


215
216
217
218
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 215

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



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
266
267
268
269
270
271
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 226

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
  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)
  _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, 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_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



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
203
204
205
206
207
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 165

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
  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)
  _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, 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_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) 


278
279
280
281
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 278

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



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
326
327
328
329
330
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 288

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
  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)
  _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, 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_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 (default to 20)

  • :page_number (Integer) —

    Page number (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:



341
342
343
344
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 341

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:



408
409
410
411
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 408

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 (default to 20)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_order (String) —

    Sort order

Returns:



473
474
475
476
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 473

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:



540
541
542
543
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 540

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



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
593
594
595
596
597
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 551

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
  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)
  _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, 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_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



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 486

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
  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']

  # 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, 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_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



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
459
460
461
462
463
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 419

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
  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)
  _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, 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_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



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
396
397
398
399
400
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 355

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
  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)
  _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, 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_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 (default to 20)

  • :page_number (Integer) —

    Page number (default to 1)

  • :q (String) —

    Search query

  • :sort_order (String) —

    Sort order

Returns:



607
608
609
610
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 607

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:



671
672
673
674
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 671

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 (default to 20)

  • :page_number (Integer) —

    Page number (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:



736
737
738
739
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 736

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



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 751

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
  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)
  _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, 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_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 (default to 20)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_order (String) —

    Sort order

Returns:



809
810
811
812
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 809

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:



876
877
878
879
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 876

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



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 887

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
  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)
  _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, 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_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



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 822

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
  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']

  # 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, 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_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 (default to 20)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_order (String) —

    Sort order

Returns:



943
944
945
946
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 943

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



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 956

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
  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[:'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, 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_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



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

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
  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)
  _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, 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_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:



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
658
659
660
661
662
663
664
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 620

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
  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[:'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, 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_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:



1009
1010
1011
1012
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1009

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



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/purecloud/api/external_contacts_api.rb', line 1019

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
  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)
  _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, 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_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:



1069
1070
1071
1072
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1069

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:



1127
1128
1129
1130
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1127

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



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

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
  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)
  _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, 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_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



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1079

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
  local_var_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, 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_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:



1188
1189
1190
1191
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1188

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:



1246
1247
1248
1249
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1246

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



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

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
  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)
  _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, 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_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



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

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
  local_var_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, 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_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:



1307
1308
1309
1310
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1307

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



1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
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
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1317

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
  local_var_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, 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_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:



1365
1366
1367
1368
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1365

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:



1428
1429
1430
1431
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1428

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



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

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
  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)
  _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, 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_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



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1376

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
  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)
  _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, 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_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:



1494
1495
1496
1497
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1494

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:



1557
1558
1559
1560
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1557

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



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
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1569

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
  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)
  _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, 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_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



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1505

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
  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)
  _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, 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_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:



1623
1624
1625
1626
 
# File 'lib/purecloud/api/external_contacts_api.rb', line 1623

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



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

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