Class: PureCloud::ExternalContactsApi

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


97
98
99
100
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 97

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 108

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
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudclient_v2a/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) 


170
171
172
173
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 170

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) 


235
236
237
238
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 235

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 246

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_trustor(external_organization_id, opts = {}) ⇒ nil

Unlink the Trustor for this External Organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Returns:

  • (nil) 


308
309
310
311
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 308

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

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

Unlink the Trustor for this External Organization

Parameters:

  • external_organization_id —

    External Organization ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 318

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 180

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) 


372
373
374
375
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 372

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



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

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:



437
438
439
440
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 437

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:



512
513
514
515
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 512

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



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 524

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:



598
599
600
601
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 598

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



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
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
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 612

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



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

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:



699
700
701
702
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 699

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



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 713

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 (String) —

    which fields, if any, to expand (externalDataSources)

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

    whether or not to include trustor information embedded in the externalOrganization

Returns:



797
798
799
800
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 797

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

Returns:



887
888
889
890
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 887

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

Returns:

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

    ContactListing data, response status code and response headers



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 902

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:



994
995
996
997
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 994

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



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
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1006

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:



1080
1081
1082
1083
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1080

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



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1094

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:



1181
1182
1183
1184
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1181

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



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

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 (String) —

    which fields, if any, to expand (externalDataSources)

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

    whether or not to include trustor information embedded in the externalOrganization

Returns:

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

    ExternalOrganization data, response status code and response headers



809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 809

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud 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

  • :trustor_id (Array<String>) —

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

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

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

    whether or not to include trustor information embedded in the externalOrganization

Returns:



1288
1289
1290
1291
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1288

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

  • :trustor_id (Array<String>) —

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

  • :sort_order (String) —

    Sort order

  • :expand (Array<String>) —

    which fields, if any, to expand

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

    whether or not to include trustor information embedded in the externalOrganization

Returns:



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
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1304

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud 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:



1401
1402
1403
1404
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1401

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



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
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1412

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:



1479
1480
1481
1482
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1479

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:



1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1490

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



1554
1555
1556
1557
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1554

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



1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1565

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:



1626
1627
1628
1629
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1626

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



1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1636

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:



1690
1691
1692
1693
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1690

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



1701
1702
1703
1704
1705
1706
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
1750
1751
1752
1753
1754
1755
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1701

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:



1762
1763
1764
1765
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1762

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



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
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1772

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:



1825
1826
1827
1828
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1825

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



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1835

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:



1889
1890
1891
1892
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1889

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:



1963
1964
1965
1966
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1963

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



1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1975

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



1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 1900

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) 


2045
2046
2047
2048
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2045

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



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2056

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:



2117
2118
2119
2120
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2117

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:



2191
2192
2193
2194
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2191

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



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2203

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_trustor_trustor_id(external_organization_id, trustor_id, opts = {}) ⇒ ExternalOrganization

Links a Trustor with an Extenral Organization

Parameters:

  • external_organization_id —

    External Organization ID

  • trustor_id —

    Trustor ID

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

    the optional parameters

Returns:



2273
2274
2275
2276
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2273

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

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

Links a Trustor with an Extenral Organization

Parameters:

  • external_organization_id —

    External Organization ID

  • trustor_id —

    Trustor ID

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

    the optional parameters

Returns:

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

    ExternalOrganization data, response status code and response headers



2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2284

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2128

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:



2348
2349
2350
2351
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2348

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



2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
 
# File 'lib/purecloudclient_v2a/api/external_contacts_api.rb', line 2359

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