Class: PureCloud::ExternalContactsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExternalContactsApi

Returns a new instance of ExternalContactsApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete an external contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_externalcontacts_contact(contact_id, opts = {})
  delete_externalcontacts_contact_with_http_info(contact_id, opts)
  return nil
end

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

Delete a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

  • (nil) 


89
90
91
92
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 89

def delete_externalcontacts_contact_note(contact_id, note_id, opts = {})
  delete_externalcontacts_contact_note_with_http_info(contact_id, note_id, opts)
  return nil
end

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

Delete a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_contact_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_externalcontacts_organization(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) 


148
149
150
151
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 148

def delete_externalcontacts_organization(external_organization_id, opts = {})
  delete_externalcontacts_organization_with_http_info(external_organization_id, opts)
  return nil
end

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

Delete a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

  • (nil) 


205
206
207
208
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 205

def delete_externalcontacts_organization_note(external_organization_id, note_id, opts = {})
  delete_externalcontacts_organization_note_with_http_info(external_organization_id, note_id, opts)
  return nil
end

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

Delete a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



216
217
218
219
220
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
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 216

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_organization_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_externalcontacts_organization_with_http_info(external_organization_id, opts = {}) ⇒ Array<(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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Returns:

  • (nil) 


264
265
266
267
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 264

def delete_externalcontacts_relationship(relationship_id, opts = {})
  delete_externalcontacts_relationship_with_http_info(relationship_id, opts)
  return nil
end

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



274
275
276
277
278
279
280
281
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
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 274

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch an external contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

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

Returns:



321
322
323
324
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 321

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

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

Fetch a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



382
383
384
385
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 382

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

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

Fetch a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    Note data, response status code and response headers



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

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_contact_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List notes for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 20)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



448
449
450
451
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 448

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

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

List notes for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    NoteListing data, response status code and response headers



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 462

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_contact_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch an external contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

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

Returns:

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

    ExternalContact data, response status code and response headers



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 332

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_externalcontacts_contacts(opts = {}) ⇒ ContactListing

Search for external contacts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

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



517
518
519
520
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 517

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

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

Search for external contacts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

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



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 531

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand (externalDataSources)

Returns:



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

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

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

Search for external contacts in an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (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 (externalOrganization)

Returns:



646
647
648
649
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 646

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

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

Search for external contacts in an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :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 (externalOrganization)

Returns:

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

    ContactListing data, response status code and response headers



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
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
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 661

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_organization_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



715
716
717
718
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 715

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

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

Fetch a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    Note data, response status code and response headers



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 727

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_organization_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List notes for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 20)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:



781
782
783
784
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 781

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

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

List notes for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

Returns:

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

    NoteListing data, response status code and response headers



795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 795

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_organization_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch a relationship for an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 20)

  • :page_number (Integer) —

    Page number (default to 1)

  • :expand (String) —

    which fields, if any, to expand

  • :sort_order (String) —

    Sort order

Returns:



850
851
852
853
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 850

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

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

Fetch a relationship for an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :expand (String) —

    which fields, if any, to expand

  • :sort_order (String) —

    Sort order

Returns:

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

    RelationshipListing data, response status code and response headers



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
908
909
910
911
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 864

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_organization_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which fields, if any, to expand (externalDataSources)

Returns:

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

    ExternalOrganization data, response status code and response headers



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 593

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_externalcontacts_organizations(opts = {}) ⇒ ExternalOrganizationListing

Search for external organizations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 20)

  • :page_number (Integer) —

    Page number (default to 1)

  • :q (String) —

    Search query

  • :sort_order (String) —

    Sort order

  • :expand (String) —

    which fields, if any, to expand

Returns:



922
923
924
925
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 922

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

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

Search for external organizations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :q (String) —

    Search query

  • :sort_order (String) —

    Sort order

  • :expand (String) —

    which fields, if any, to expand

Returns:



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
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 936

def get_externalcontacts_organizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.get_externalcontacts_organizations ..."
  end
  if opts[:'expand'] && !['externalDataSources'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of externalDataSources'
  end
  # resource path
  local_var_path = "/api/v2/externalcontacts/organizations".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'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Fetch a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    which fields, if any, to expand

Returns:



990
991
992
993
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 990

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

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

Fetch a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    which fields, if any, to expand

Returns:

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

    Relationship data, response status code and response headers



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

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud 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_externalcontacts_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Lookup contacts and externalOrganizations based on an attribute

Parameters:

  • lookup_val —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which field, if any, to expand

Returns:



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

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

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

Lookup contacts and externalOrganizations based on an attribute

Parameters:

  • lookup_val —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    which field, if any, to expand

Returns:



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

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Associate an external contact with a conversation

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1114
1115
1116
1117
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1114

def post_externalcontacts_contact_associateconversation(contact_id, opts = {})
  post_externalcontacts_contact_associateconversation_with_http_info(contact_id, opts)
  return nil
end

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

Associate an external contact with a conversation

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1125

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Create a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    ExternalContact

Returns:



1172
1173
1174
1175
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1172

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

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

Create a note for an external contact

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



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
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
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1183

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_contact_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_externalcontacts_contacts(opts = {}) ⇒ ExternalContact

Create an external contact

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1230
1231
1232
1233
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1230

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

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

Create an external contact

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ExternalContact data, response status code and response headers



1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1240

def post_externalcontacts_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_externalcontacts_organization_notes(external_organization_id, 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:



1286
1287
1288
1289
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1286

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

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



1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1297

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_organization_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_externalcontacts_organizations(opts = {}) ⇒ ExternalOrganization

Create an external organization

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1344
1345
1346
1347
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1344

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

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



1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1354

def post_externalcontacts_organizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_externalcontacts_relationships(opts = {}) ⇒ Relationship

Create a relationship

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1399
1400
1401
1402
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1399

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

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



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

def post_externalcontacts_relationships_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ExternalContactsApi.post_externalcontacts_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update an external contact

Parameters:

  • contact_id —

    ExternalContact ID

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

    the optional parameters

Options Hash (opts):

Returns:



1455
1456
1457
1458
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1455

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

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

Update a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    Note

Returns:



1515
1516
1517
1518
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1515

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

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

Update a note for an external contact

Parameters:

  • contact_id —

    ExternalContact Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    Note

Returns:

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

    Note data, response status code and response headers



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1527

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_contact_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update an external contact

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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Associate an external contact with a conversation

Parameters:

  • conversation_id —

    Conversation ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1577
1578
1579
1580
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1577

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

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

Associate an external contact with a conversation

Parameters:

  • conversation_id —

    Conversation ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update an external organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Options Hash (opts):

Returns:



1635
1636
1637
1638
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1635

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

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

Update a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    Note

Returns:



1695
1696
1697
1698
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1695

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

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

Update a note for an external organization

Parameters:

  • external_organization_id —

    External Organization Id

  • note_id —

    Note Id

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

    the optional parameters

Options Hash (opts):

  • :body (Note) —

    Note

Returns:

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

    Note data, response status code and response headers



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1707

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_organization_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_externalcontacts_organization_with_http_info(external_organization_id, 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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a relationship

Parameters:

  • relationship_id —

    Relationship Id

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

    the optional parameters

Options Hash (opts):

Returns:



1757
1758
1759
1760
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1757

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

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



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
 
# File 'lib/purecloudplatformclientv2/api/external_contacts_api.rb', line 1768

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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_externalcontacts_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end