Class: PureCloud::ConversationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/conversations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConversationsApi

Returns a new instance of ConversationsApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#delete_calls_call_id_participants_participant_id_consult(call_id, participant_id, opts = {}) ⇒ String

Cancel the transfer

Parameters:

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

    the optional parameters

Returns:

  • (String) 


1391
1392
1393
1394
 
# File 'lib/purecloud/api/conversations_api.rb', line 1391

def delete_calls_call_id_participants_participant_id_consult(call_id, participant_id, opts = {})
  data, status_code, headers = delete_calls_call_id_participants_participant_id_consult_with_http_info(call_id, participant_id, opts)
  return data
end

#delete_calls_call_id_participants_participant_id_consult_with_http_info(call_id, participant_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Cancel the transfer

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def delete_calls_call_id_participants_participant_id_consult_with_http_info(call_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#delete_calls_call_id_participants_participant_id_consult ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling delete_calls_call_id_participants_participant_id_consult" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling delete_calls_call_id_participants_participant_id_consult" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants/{participantId}/consult".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#delete_calls_call_id_participants_participant_id_consult\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_emails_email_id_messages_draft_attachments_attachment_id(email_id, attachment_id, opts = {}) ⇒ String

Delete attachment from draft

Parameters:

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

    the optional parameters

Returns:

  • (String) 


2610
2611
2612
2613
 
# File 'lib/purecloud/api/conversations_api.rb', line 2610

def delete_emails_email_id_messages_draft_attachments_attachment_id(email_id, attachment_id, opts = {})
  data, status_code, headers = delete_emails_email_id_messages_draft_attachments_attachment_id_with_http_info(email_id, attachment_id, opts)
  return data
end

#delete_emails_email_id_messages_draft_attachments_attachment_id_with_http_info(email_id, attachment_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete attachment from draft

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
 
# File 'lib/purecloud/api/conversations_api.rb', line 2621

def delete_emails_email_id_messages_draft_attachments_attachment_id_with_http_info(email_id, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#delete_emails_email_id_messages_draft_attachments_attachment_id ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling delete_emails_email_id_messages_draft_attachments_attachment_id" if email_id.nil?
  
  # verify the required parameter 'attachment_id' is set
  fail "Missing the required parameter 'attachment_id' when calling delete_emails_email_id_messages_draft_attachments_attachment_id" if attachment_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/messages/draft/attachments/{attachmentId}".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s).sub('{' + 'attachmentId' + '}', attachment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#delete_emails_email_id_messages_draft_attachments_attachment_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callbacks(opts = {}) ⇒ CallbackConversationEntityListing

Get callback conversations

Parameters:

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

    the optional parameters

Returns:



314
315
316
317
 
# File 'lib/purecloud/api/conversations_api.rb', line 314

def get_callbacks(opts = {})
  data, status_code, headers = get_callbacks_with_http_info(opts)
  return data
end

#get_callbacks_callback_id(callback_id, opts = {}) ⇒ CallbackConversation

Get callback conversation

Parameters:

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

    the optional parameters

Returns:



371
372
373
374
 
# File 'lib/purecloud/api/conversations_api.rb', line 371

def get_callbacks_callback_id(callback_id, opts = {})
  data, status_code, headers = get_callbacks_callback_id_with_http_info(callback_id, opts)
  return data
end

#get_callbacks_callback_id_participants_participant_id_wrapup(callback_id, participant_id, opts = {}) ⇒ WrapupCode

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:



635
636
637
638
 
# File 'lib/purecloud/api/conversations_api.rb', line 635

def get_callbacks_callback_id_participants_participant_id_wrapup(callback_id, participant_id, opts = {})
  data, status_code, headers = get_callbacks_callback_id_participants_participant_id_wrapup_with_http_info(callback_id, participant_id, opts)
  return data
end

#get_callbacks_callback_id_participants_participant_id_wrapup_with_http_info(callback_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    WrapupCode data, response status code and response headers



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
689
690
691
692
693
694
695
 
# File 'lib/purecloud/api/conversations_api.rb', line 647

def get_callbacks_callback_id_participants_participant_id_wrapup_with_http_info(callback_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_callbacks_callback_id_participants_participant_id_wrapup ..."
  end
  
  # verify the required parameter 'callback_id' is set
  fail "Missing the required parameter 'callback_id' when calling get_callbacks_callback_id_participants_participant_id_wrapup" if callback_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_callbacks_callback_id_participants_participant_id_wrapup" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapup".sub('{format}','json').sub('{' + 'callbackId' + '}', callback_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_callbacks_callback_id_participants_participant_id_wrapup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callbacks_callback_id_participants_participant_id_wrapupcodes(callback_id, participant_id, opts = {}) ⇒ WrapupCode

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:



703
704
705
706
 
# File 'lib/purecloud/api/conversations_api.rb', line 703

def get_callbacks_callback_id_participants_participant_id_wrapupcodes(callback_id, participant_id, opts = {})
  data, status_code, headers = get_callbacks_callback_id_participants_participant_id_wrapupcodes_with_http_info(callback_id, participant_id, opts)
  return data
end

#get_callbacks_callback_id_participants_participant_id_wrapupcodes_with_http_info(callback_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:

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

    WrapupCode data, response status code and response headers



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

def get_callbacks_callback_id_participants_participant_id_wrapupcodes_with_http_info(callback_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_callbacks_callback_id_participants_participant_id_wrapupcodes ..."
  end
  
  # verify the required parameter 'callback_id' is set
  fail "Missing the required parameter 'callback_id' when calling get_callbacks_callback_id_participants_participant_id_wrapupcodes" if callback_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_callbacks_callback_id_participants_participant_id_wrapupcodes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapupcodes".sub('{format}','json').sub('{' + 'callbackId' + '}', callback_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_callbacks_callback_id_participants_participant_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callbacks_callback_id_with_http_info(callback_id, opts = {}) ⇒ Array<(CallbackConversation, Fixnum, Hash)>

Get callback conversation

Parameters:

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

    the optional parameters

Returns:

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

    CallbackConversation data, response status code and response headers



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

def get_callbacks_callback_id_with_http_info(callback_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_callbacks_callback_id ..."
  end
  
  # verify the required parameter 'callback_id' is set
  fail "Missing the required parameter 'callback_id' when calling get_callbacks_callback_id" if callback_id.nil?
  
  # resource path
  path = "/api/v2/conversations/callbacks/{callbackId}".sub('{format}','json').sub('{' + 'callbackId' + '}', callback_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallbackConversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_callbacks_callback_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callbacks_with_http_info(opts = {}) ⇒ Array<(CallbackConversationEntityListing, Fixnum, Hash)>

Get callback conversations

Parameters:

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

    the optional parameters

Returns:



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

def get_callbacks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_callbacks ..."
  end
  
  # resource path
  path = "/api/v2/conversations/callbacks".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallbackConversationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_callbacks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_calls(opts = {}) ⇒ CallConversationEntityListing

Get recent conversations

Parameters:

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

    the optional parameters

Returns:



767
768
769
770
 
# File 'lib/purecloud/api/conversations_api.rb', line 767

def get_calls(opts = {})
  data, status_code, headers = get_calls_with_http_info(opts)
  return data
end

#get_calls_call_id(call_id, opts = {}) ⇒ CallConversation

Get call conversation

Parameters:

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

    the optional parameters

Returns:



938
939
940
941
 
# File 'lib/purecloud/api/conversations_api.rb', line 938

def get_calls_call_id(call_id, opts = {})
  data, status_code, headers = get_calls_call_id_with_http_info(call_id, opts)
  return data
end

#get_calls_call_id_participants_participant_id_wrapup(call_id, participant_id, opts = {}) ⇒ WrapupCode

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:



1658
1659
1660
1661
 
# File 'lib/purecloud/api/conversations_api.rb', line 1658

def get_calls_call_id_participants_participant_id_wrapup(call_id, participant_id, opts = {})
  data, status_code, headers = get_calls_call_id_participants_participant_id_wrapup_with_http_info(call_id, participant_id, opts)
  return data
end

#get_calls_call_id_participants_participant_id_wrapup_with_http_info(call_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    WrapupCode data, response status code and response headers



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
 
# File 'lib/purecloud/api/conversations_api.rb', line 1670

def get_calls_call_id_participants_participant_id_wrapup_with_http_info(call_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_calls_call_id_participants_participant_id_wrapup ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling get_calls_call_id_participants_participant_id_wrapup" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_calls_call_id_participants_participant_id_wrapup" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants/{participantId}/wrapup".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_calls_call_id_participants_participant_id_wrapup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_calls_call_id_participants_participant_id_wrapupcodes(call_id, participant_id, opts = {}) ⇒ WrapupCode

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:



1726
1727
1728
1729
 
# File 'lib/purecloud/api/conversations_api.rb', line 1726

def get_calls_call_id_participants_participant_id_wrapupcodes(call_id, participant_id, opts = {})
  data, status_code, headers = get_calls_call_id_participants_participant_id_wrapupcodes_with_http_info(call_id, participant_id, opts)
  return data
end

#get_calls_call_id_participants_participant_id_wrapupcodes_with_http_info(call_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:

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

    WrapupCode data, response status code and response headers



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

def get_calls_call_id_participants_participant_id_wrapupcodes_with_http_info(call_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_calls_call_id_participants_participant_id_wrapupcodes ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling get_calls_call_id_participants_participant_id_wrapupcodes" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_calls_call_id_participants_participant_id_wrapupcodes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants/{participantId}/wrapupcodes".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_calls_call_id_participants_participant_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_calls_call_id_with_http_info(call_id, opts = {}) ⇒ Array<(CallConversation, Fixnum, Hash)>

Get call conversation

Parameters:

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

    the optional parameters

Returns:

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

    CallConversation data, response status code and response headers



948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
 
# File 'lib/purecloud/api/conversations_api.rb', line 948

def get_calls_call_id_with_http_info(call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_calls_call_id ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling get_calls_call_id" if call_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallConversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_calls_call_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_calls_maximumconferenceparties(opts = {}) ⇒ MaxParticipants

Get the maximum number of participants that this user can have on a conference

Parameters:

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

    the optional parameters

Returns:



881
882
883
884
 
# File 'lib/purecloud/api/conversations_api.rb', line 881

def get_calls_maximumconferenceparties(opts = {})
  data, status_code, headers = get_calls_maximumconferenceparties_with_http_info(opts)
  return data
end

#get_calls_maximumconferenceparties_with_http_info(opts = {}) ⇒ Array<(MaxParticipants, Fixnum, Hash)>

Get the maximum number of participants that this user can have on a conference

Parameters:

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

    the optional parameters

Returns:

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

    MaxParticipants data, response status code and response headers



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

def get_calls_maximumconferenceparties_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_calls_maximumconferenceparties ..."
  end
  
  # resource path
  path = "/api/v2/conversations/calls/maximumconferenceparties".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MaxParticipants')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_calls_maximumconferenceparties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_calls_with_http_info(opts = {}) ⇒ Array<(CallConversationEntityListing, Fixnum, Hash)>

Get recent conversations

Parameters:

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

    the optional parameters

Returns:



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/purecloud/api/conversations_api.rb', line 776

def get_calls_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_calls ..."
  end
  
  # resource path
  path = "/api/v2/conversations/calls".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallConversationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chats(opts = {}) ⇒ ChatConversationEntityListing

Get recent chat conversations

Parameters:

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

    the optional parameters

Returns:



1790
1791
1792
1793
 
# File 'lib/purecloud/api/conversations_api.rb', line 1790

def get_chats(opts = {})
  data, status_code, headers = get_chats_with_http_info(opts)
  return data
end

#get_chats_chat_id(chat_id, opts = {}) ⇒ ChatConversation

Get chat conversation

Parameters:

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

    the optional parameters

Returns:



1847
1848
1849
1850
 
# File 'lib/purecloud/api/conversations_api.rb', line 1847

def get_chats_chat_id(chat_id, opts = {})
  data, status_code, headers = get_chats_chat_id_with_http_info(chat_id, opts)
  return data
end

#get_chats_chat_id_participants_participant_id_wrapup(chat_id, participant_id, opts = {}) ⇒ WrapupCode

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:



2111
2112
2113
2114
 
# File 'lib/purecloud/api/conversations_api.rb', line 2111

def get_chats_chat_id_participants_participant_id_wrapup(chat_id, participant_id, opts = {})
  data, status_code, headers = get_chats_chat_id_participants_participant_id_wrapup_with_http_info(chat_id, participant_id, opts)
  return data
end

#get_chats_chat_id_participants_participant_id_wrapup_with_http_info(chat_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    WrapupCode data, response status code and response headers



2123
2124
2125
2126
2127
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
 
# File 'lib/purecloud/api/conversations_api.rb', line 2123

def get_chats_chat_id_participants_participant_id_wrapup_with_http_info(chat_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_chats_chat_id_participants_participant_id_wrapup ..."
  end
  
  # verify the required parameter 'chat_id' is set
  fail "Missing the required parameter 'chat_id' when calling get_chats_chat_id_participants_participant_id_wrapup" if chat_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_chats_chat_id_participants_participant_id_wrapup" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapup".sub('{format}','json').sub('{' + 'chatId' + '}', chat_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_chats_chat_id_participants_participant_id_wrapup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chats_chat_id_participants_participant_id_wrapupcodes(chat_id, participant_id, opts = {}) ⇒ WrapupCode

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:



2179
2180
2181
2182
 
# File 'lib/purecloud/api/conversations_api.rb', line 2179

def get_chats_chat_id_participants_participant_id_wrapupcodes(chat_id, participant_id, opts = {})
  data, status_code, headers = get_chats_chat_id_participants_participant_id_wrapupcodes_with_http_info(chat_id, participant_id, opts)
  return data
end

#get_chats_chat_id_participants_participant_id_wrapupcodes_with_http_info(chat_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:

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

    WrapupCode data, response status code and response headers



2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
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
 
# File 'lib/purecloud/api/conversations_api.rb', line 2190

def get_chats_chat_id_participants_participant_id_wrapupcodes_with_http_info(chat_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_chats_chat_id_participants_participant_id_wrapupcodes ..."
  end
  
  # verify the required parameter 'chat_id' is set
  fail "Missing the required parameter 'chat_id' when calling get_chats_chat_id_participants_participant_id_wrapupcodes" if chat_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_chats_chat_id_participants_participant_id_wrapupcodes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapupcodes".sub('{format}','json').sub('{' + 'chatId' + '}', chat_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_chats_chat_id_participants_participant_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chats_chat_id_with_http_info(chat_id, opts = {}) ⇒ Array<(ChatConversation, Fixnum, Hash)>

Get chat conversation

Parameters:

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

    the optional parameters

Returns:

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

    ChatConversation data, response status code and response headers



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
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
 
# File 'lib/purecloud/api/conversations_api.rb', line 1857

def get_chats_chat_id_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_chats_chat_id ..."
  end
  
  # verify the required parameter 'chat_id' is set
  fail "Missing the required parameter 'chat_id' when calling get_chats_chat_id" if chat_id.nil?
  
  # resource path
  path = "/api/v2/conversations/chats/{chatId}".sub('{format}','json').sub('{' + 'chatId' + '}', chat_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ChatConversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_chats_chat_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chats_with_http_info(opts = {}) ⇒ Array<(ChatConversationEntityListing, Fixnum, Hash)>

Get recent chat conversations

Parameters:

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

    the optional parameters

Returns:



1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
 
# File 'lib/purecloud/api/conversations_api.rb', line 1799

def get_chats_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_chats ..."
  end
  
  # resource path
  path = "/api/v2/conversations/chats".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ChatConversationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_chats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_id(conversation_id, opts = {}) ⇒ Conversation

Get conversation

Parameters:

  • conversation_id —

    conversation ID

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

    the optional parameters

Returns:



3588
3589
3590
3591
 
# File 'lib/purecloud/api/conversations_api.rb', line 3588

def get_conversation_id(conversation_id, opts = {})
  data, status_code, headers = get_conversation_id_with_http_info(conversation_id, opts)
  return data
end

#get_conversation_id_participants_participant_id_wrapup(conversation_id, participant_id, opts = {}) ⇒ WrapupCode

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:



3919
3920
3921
3922
 
# File 'lib/purecloud/api/conversations_api.rb', line 3919

def get_conversation_id_participants_participant_id_wrapup(conversation_id, participant_id, opts = {})
  data, status_code, headers = get_conversation_id_participants_participant_id_wrapup_with_http_info(conversation_id, participant_id, opts)
  return data
end

#get_conversation_id_participants_participant_id_wrapup_with_http_info(conversation_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    WrapupCode data, response status code and response headers



3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
 
# File 'lib/purecloud/api/conversations_api.rb', line 3931

def get_conversation_id_participants_participant_id_wrapup_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_conversation_id_participants_participant_id_wrapup ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_participants_participant_id_wrapup" if conversation_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_conversation_id_participants_participant_id_wrapup" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversation_id_participants_participant_id_wrapup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_id_participants_participant_id_wrapupcodes(conversation_id, participant_id, opts = {}) ⇒ WrapupCode

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Returns:



3987
3988
3989
3990
 
# File 'lib/purecloud/api/conversations_api.rb', line 3987

def get_conversation_id_participants_participant_id_wrapupcodes(conversation_id, participant_id, opts = {})
  data, status_code, headers = get_conversation_id_participants_participant_id_wrapupcodes_with_http_info(conversation_id, participant_id, opts)
  return data
end

#get_conversation_id_participants_participant_id_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Returns:

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

    WrapupCode data, response status code and response headers



3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
 
# File 'lib/purecloud/api/conversations_api.rb', line 3998

def get_conversation_id_participants_participant_id_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_conversation_id_participants_participant_id_wrapupcodes ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_participants_participant_id_wrapupcodes" if conversation_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_conversation_id_participants_participant_id_wrapupcodes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversation_id_participants_participant_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversation_id_with_http_info(conversation_id, opts = {}) ⇒ Array<(Conversation, Fixnum, Hash)>

Get conversation

Parameters:

  • conversation_id —

    conversation ID

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
 
# File 'lib/purecloud/api/conversations_api.rb', line 3598

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Conversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversations(opts = {}) ⇒ ConversationEntityListing

Get conversations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :communication_type (String) —

    Call or Chat communication filtering

Returns:



256
257
258
259
 
# File 'lib/purecloud/api/conversations_api.rb', line 256

def get_conversations(opts = {})
  data, status_code, headers = get_conversations_with_http_info(opts)
  return data
end

#get_conversations_conversation_id_details(conversation_id, opts = {}) ⇒ AnalyticsConversation

Get a conversation by id

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



132
133
134
135
 
# File 'lib/purecloud/api/conversations_api.rb', line 132

def get_conversations_conversation_id_details(conversation_id, opts = {})
  data, status_code, headers = get_conversations_conversation_id_details_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_conversation_id_details_with_http_info(conversation_id, opts = {}) ⇒ Array<(AnalyticsConversation, Fixnum, Hash)>

Get a conversation by id

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    AnalyticsConversation data, response status code and response headers



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/purecloud/api/conversations_api.rb', line 142

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AnalyticsConversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversations_conversation_id_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversations_with_http_info(opts = {}) ⇒ Array<(ConversationEntityListing, Fixnum, Hash)>

Get conversations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :communication_type (String) —

    Call or Chat communication filtering

Returns:

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

    ConversationEntityListing data, response status code and response headers



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
302
303
304
305
306
307
308
 
# File 'lib/purecloud/api/conversations_api.rb', line 266

def get_conversations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_conversations ..."
  end
  
  # resource path
  path = "/api/v2/conversations".sub('{format}','json')

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConversationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_emails(opts = {}) ⇒ EmailConversationEntityListing

Get recent email conversations

Parameters:

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

    the optional parameters

Returns:



2243
2244
2245
2246
 
# File 'lib/purecloud/api/conversations_api.rb', line 2243

def get_emails(opts = {})
  data, status_code, headers = get_emails_with_http_info(opts)
  return data
end

#get_emails_email_id(email_id, opts = {}) ⇒ EmailConversation

Get email conversation

Parameters:

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

    the optional parameters

Returns:



2300
2301
2302
2303
 
# File 'lib/purecloud/api/conversations_api.rb', line 2300

def get_emails_email_id(email_id, opts = {})
  data, status_code, headers = get_emails_email_id_with_http_info(email_id, opts)
  return data
end

#get_emails_email_id_messages(email_id, opts = {}) ⇒ EmailMessageListing

Get conversation messages

Parameters:

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

    the optional parameters

Returns:



2361
2362
2363
2364
 
# File 'lib/purecloud/api/conversations_api.rb', line 2361

def get_emails_email_id_messages(email_id, opts = {})
  data, status_code, headers = get_emails_email_id_messages_with_http_info(email_id, opts)
  return data
end

#get_emails_email_id_messages_draft(email_id, opts = {}) ⇒ EmailMessage

Get conversation draft reply

Parameters:

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

    the optional parameters

Returns:



2485
2486
2487
2488
 
# File 'lib/purecloud/api/conversations_api.rb', line 2485

def get_emails_email_id_messages_draft(email_id, opts = {})
  data, status_code, headers = get_emails_email_id_messages_draft_with_http_info(email_id, opts)
  return data
end

#get_emails_email_id_messages_draft_with_http_info(email_id, opts = {}) ⇒ Array<(EmailMessage, Fixnum, Hash)>

Get conversation draft reply

Parameters:

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
 
# File 'lib/purecloud/api/conversations_api.rb', line 2495

def get_emails_email_id_messages_draft_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_emails_email_id_messages_draft ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling get_emails_email_id_messages_draft" if email_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/messages/draft".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_emails_email_id_messages_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_emails_email_id_messages_message_id(email_id, message_id, opts = {}) ⇒ EmailMessage

Get conversation message

Parameters:

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

    the optional parameters

Returns:



2676
2677
2678
2679
 
# File 'lib/purecloud/api/conversations_api.rb', line 2676

def get_emails_email_id_messages_message_id(email_id, message_id, opts = {})
  data, status_code, headers = get_emails_email_id_messages_message_id_with_http_info(email_id, message_id, opts)
  return data
end

#get_emails_email_id_messages_message_id_with_http_info(email_id, message_id, opts = {}) ⇒ Array<(EmailMessage, Fixnum, Hash)>

Get conversation message

Parameters:

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
 
# File 'lib/purecloud/api/conversations_api.rb', line 2687

def get_emails_email_id_messages_message_id_with_http_info(email_id, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_emails_email_id_messages_message_id ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling get_emails_email_id_messages_message_id" if email_id.nil?
  
  # verify the required parameter 'message_id' is set
  fail "Missing the required parameter 'message_id' when calling get_emails_email_id_messages_message_id" if message_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/messages/{messageId}".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_emails_email_id_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_emails_email_id_messages_with_http_info(email_id, opts = {}) ⇒ Array<(EmailMessageListing, Fixnum, Hash)>

Get conversation messages

Parameters:

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

    the optional parameters

Returns:

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

    EmailMessageListing data, response status code and response headers



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
2414
2415
 
# File 'lib/purecloud/api/conversations_api.rb', line 2371

def get_emails_email_id_messages_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_emails_email_id_messages ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling get_emails_email_id_messages" if email_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/messages".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailMessageListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_emails_email_id_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_emails_email_id_participants_participant_id_wrapup(email_id, participant_id, opts = {}) ⇒ WrapupCode

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:



2944
2945
2946
2947
 
# File 'lib/purecloud/api/conversations_api.rb', line 2944

def get_emails_email_id_participants_participant_id_wrapup(email_id, participant_id, opts = {})
  data, status_code, headers = get_emails_email_id_participants_participant_id_wrapup_with_http_info(email_id, participant_id, opts)
  return data
end

#get_emails_email_id_participants_participant_id_wrapup_with_http_info(email_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    WrapupCode data, response status code and response headers



2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
 
# File 'lib/purecloud/api/conversations_api.rb', line 2956

def get_emails_email_id_participants_participant_id_wrapup_with_http_info(email_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_emails_email_id_participants_participant_id_wrapup ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling get_emails_email_id_participants_participant_id_wrapup" if email_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_emails_email_id_participants_participant_id_wrapup" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapup".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_emails_email_id_participants_participant_id_wrapup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_emails_email_id_participants_participant_id_wrapupcodes(email_id, participant_id, opts = {}) ⇒ WrapupCode

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:



3012
3013
3014
3015
 
# File 'lib/purecloud/api/conversations_api.rb', line 3012

def get_emails_email_id_participants_participant_id_wrapupcodes(email_id, participant_id, opts = {})
  data, status_code, headers = get_emails_email_id_participants_participant_id_wrapupcodes_with_http_info(email_id, participant_id, opts)
  return data
end

#get_emails_email_id_participants_participant_id_wrapupcodes_with_http_info(email_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:

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

    WrapupCode data, response status code and response headers



3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
 
# File 'lib/purecloud/api/conversations_api.rb', line 3023

def get_emails_email_id_participants_participant_id_wrapupcodes_with_http_info(email_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_emails_email_id_participants_participant_id_wrapupcodes ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling get_emails_email_id_participants_participant_id_wrapupcodes" if email_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_emails_email_id_participants_participant_id_wrapupcodes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapupcodes".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_emails_email_id_participants_participant_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_emails_email_id_with_http_info(email_id, opts = {}) ⇒ Array<(EmailConversation, Fixnum, Hash)>

Get email conversation

Parameters:

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

    the optional parameters

Returns:

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

    EmailConversation data, response status code and response headers



2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
 
# File 'lib/purecloud/api/conversations_api.rb', line 2310

def get_emails_email_id_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_emails_email_id ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling get_emails_email_id" if email_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailConversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_emails_email_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_emails_with_http_info(opts = {}) ⇒ Array<(EmailConversationEntityListing, Fixnum, Hash)>

Get recent email conversations

Parameters:

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

    the optional parameters

Returns:



2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/purecloud/api/conversations_api.rb', line 2252

def get_emails_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_emails ..."
  end
  
  # resource path
  path = "/api/v2/conversations/emails".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailConversationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_videos(opts = {}) ⇒ VideoConversationEntityListing

Get recent video conversations

Parameters:

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

    the optional parameters

Returns:



3134
3135
3136
3137
 
# File 'lib/purecloud/api/conversations_api.rb', line 3134

def get_videos(opts = {})
  data, status_code, headers = get_videos_with_http_info(opts)
  return data
end

#get_videos_video_id(video_id, opts = {}) ⇒ VideoConversation

Get video conversation

Parameters:

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

    the optional parameters

Returns:



3191
3192
3193
3194
 
# File 'lib/purecloud/api/conversations_api.rb', line 3191

def get_videos_video_id(video_id, opts = {})
  data, status_code, headers = get_videos_video_id_with_http_info(video_id, opts)
  return data
end

#get_videos_video_id_participants_participant_id_wrapup(video_id, participant_id, opts = {}) ⇒ WrapupCode

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:



3455
3456
3457
3458
 
# File 'lib/purecloud/api/conversations_api.rb', line 3455

def get_videos_video_id_participants_participant_id_wrapup(video_id, participant_id, opts = {})
  data, status_code, headers = get_videos_video_id_participants_participant_id_wrapup_with_http_info(video_id, participant_id, opts)
  return data
end

#get_videos_video_id_participants_participant_id_wrapup_with_http_info(video_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get the wrap-up for this conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    WrapupCode data, response status code and response headers



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

def get_videos_video_id_participants_participant_id_wrapup_with_http_info(video_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_videos_video_id_participants_participant_id_wrapup ..."
  end
  
  # verify the required parameter 'video_id' is set
  fail "Missing the required parameter 'video_id' when calling get_videos_video_id_participants_participant_id_wrapup" if video_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_videos_video_id_participants_participant_id_wrapup" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/videos/{videoId}/participants/{participantId}/wrapup".sub('{format}','json').sub('{' + 'videoId' + '}', video_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_videos_video_id_participants_participant_id_wrapup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_videos_video_id_participants_participant_id_wrapupcodes(video_id, participant_id, opts = {}) ⇒ WrapupCode

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:



3523
3524
3525
3526
 
# File 'lib/purecloud/api/conversations_api.rb', line 3523

def get_videos_video_id_participants_participant_id_wrapupcodes(video_id, participant_id, opts = {})
  data, status_code, headers = get_videos_video_id_participants_participant_id_wrapupcodes_with_http_info(video_id, participant_id, opts)
  return data
end

#get_videos_video_id_participants_participant_id_wrapupcodes_with_http_info(video_id, participant_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get list of wrapup codes for this conversation participant

Parameters:

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

    the optional parameters

Returns:

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

    WrapupCode data, response status code and response headers



3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
 
# File 'lib/purecloud/api/conversations_api.rb', line 3534

def get_videos_video_id_participants_participant_id_wrapupcodes_with_http_info(video_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_videos_video_id_participants_participant_id_wrapupcodes ..."
  end
  
  # verify the required parameter 'video_id' is set
  fail "Missing the required parameter 'video_id' when calling get_videos_video_id_participants_participant_id_wrapupcodes" if video_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling get_videos_video_id_participants_participant_id_wrapupcodes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/videos/{videoId}/participants/{participantId}/wrapupcodes".sub('{format}','json').sub('{' + 'videoId' + '}', video_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_videos_video_id_participants_participant_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_videos_video_id_with_http_info(video_id, opts = {}) ⇒ Array<(VideoConversation, Fixnum, Hash)>

Get video conversation

Parameters:

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

    the optional parameters

Returns:

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

    VideoConversation data, response status code and response headers



3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
 
# File 'lib/purecloud/api/conversations_api.rb', line 3201

def get_videos_video_id_with_http_info(video_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_videos_video_id ..."
  end
  
  # verify the required parameter 'video_id' is set
  fail "Missing the required parameter 'video_id' when calling get_videos_video_id" if video_id.nil?
  
  # resource path
  path = "/api/v2/conversations/videos/{videoId}".sub('{format}','json').sub('{' + 'videoId' + '}', video_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VideoConversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_videos_video_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_videos_with_http_info(opts = {}) ⇒ Array<(VideoConversationEntityListing, Fixnum, Hash)>

Get recent video conversations

Parameters:

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

    the optional parameters

Returns:



3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
 
# File 'lib/purecloud/api/conversations_api.rb', line 3143

def get_videos_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_videos ..."
  end
  
  # resource path
  path = "/api/v2/conversations/videos".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VideoConversationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_videos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_callbacks_callback_id_participants_participant_id(callback_id, participant_id, opts = {}) ⇒ nil

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


434
435
436
437
 
# File 'lib/purecloud/api/conversations_api.rb', line 434

def patch_callbacks_callback_id_participants_participant_id(callback_id, participant_id, opts = {})
  patch_callbacks_callback_id_participants_participant_id_with_http_info(callback_id, participant_id, opts)
  return nil
end

#patch_callbacks_callback_id_participants_participant_id_attributes(callback_id, participant_id, opts = {}) ⇒ nil

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


501
502
503
504
 
# File 'lib/purecloud/api/conversations_api.rb', line 501

def patch_callbacks_callback_id_participants_participant_id_attributes(callback_id, participant_id, opts = {})
  patch_callbacks_callback_id_participants_participant_id_attributes_with_http_info(callback_id, participant_id, opts)
  return nil
end

#patch_callbacks_callback_id_participants_participant_id_attributes_with_http_info(callback_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/purecloud/api/conversations_api.rb', line 513

def patch_callbacks_callback_id_participants_participant_id_attributes_with_http_info(callback_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_callbacks_callback_id_participants_participant_id_attributes ..."
  end
  
  # verify the required parameter 'callback_id' is set
  fail "Missing the required parameter 'callback_id' when calling patch_callbacks_callback_id_participants_participant_id_attributes" if callback_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_callbacks_callback_id_participants_participant_id_attributes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/attributes".sub('{format}','json').sub('{' + 'callbackId' + '}', callback_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_callbacks_callback_id_participants_participant_id_with_http_info(callback_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



446
447
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
 
# File 'lib/purecloud/api/conversations_api.rb', line 446

def patch_callbacks_callback_id_participants_participant_id_with_http_info(callback_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_callbacks_callback_id_participants_participant_id ..."
  end
  
  # verify the required parameter 'callback_id' is set
  fail "Missing the required parameter 'callback_id' when calling patch_callbacks_callback_id_participants_participant_id" if callback_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_callbacks_callback_id_participants_participant_id" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}".sub('{format}','json').sub('{' + 'callbackId' + '}', callback_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_calls_call_id(call_id, opts = {}) ⇒ Conversation

Update conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1063
1064
1065
1066
 
# File 'lib/purecloud/api/conversations_api.rb', line 1063

def patch_calls_call_id(call_id, opts = {})
  data, status_code, headers = patch_calls_call_id_with_http_info(call_id, opts)
  return data
end

#patch_calls_call_id_participants_participant_id(call_id, participant_id, opts = {}) ⇒ nil

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1190
1191
1192
1193
 
# File 'lib/purecloud/api/conversations_api.rb', line 1190

def patch_calls_call_id_participants_participant_id(call_id, participant_id, opts = {})
  patch_calls_call_id_participants_participant_id_with_http_info(call_id, participant_id, opts)
  return nil
end

#patch_calls_call_id_participants_participant_id_attributes(call_id, participant_id, opts = {}) ⇒ nil

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1257
1258
1259
1260
 
# File 'lib/purecloud/api/conversations_api.rb', line 1257

def patch_calls_call_id_participants_participant_id_attributes(call_id, participant_id, opts = {})
  patch_calls_call_id_participants_participant_id_attributes_with_http_info(call_id, participant_id, opts)
  return nil
end

#patch_calls_call_id_participants_participant_id_attributes_with_http_info(call_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/purecloud/api/conversations_api.rb', line 1269

def patch_calls_call_id_participants_participant_id_attributes_with_http_info(call_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_calls_call_id_participants_participant_id_attributes ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling patch_calls_call_id_participants_participant_id_attributes" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_calls_call_id_participants_participant_id_attributes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants/{participantId}/attributes".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_calls_call_id_participants_participant_id_consult(call_id, participant_id, opts = {}) ⇒ ConsultTransferResponse

Change who can speak

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1458
1459
1460
1461
 
# File 'lib/purecloud/api/conversations_api.rb', line 1458

def patch_calls_call_id_participants_participant_id_consult(call_id, participant_id, opts = {})
  data, status_code, headers = patch_calls_call_id_participants_participant_id_consult_with_http_info(call_id, participant_id, opts)
  return data
end

#patch_calls_call_id_participants_participant_id_consult_with_http_info(call_id, participant_id, opts = {}) ⇒ Array<(ConsultTransferResponse, Fixnum, Hash)>

Change who can speak

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ConsultTransferResponse data, response status code and response headers



1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
 
# File 'lib/purecloud/api/conversations_api.rb', line 1470

def patch_calls_call_id_participants_participant_id_consult_with_http_info(call_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_calls_call_id_participants_participant_id_consult ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling patch_calls_call_id_participants_participant_id_consult" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_calls_call_id_participants_participant_id_consult" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants/{participantId}/consult".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConsultTransferResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#patch_calls_call_id_participants_participant_id_consult\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_calls_call_id_participants_participant_id_with_http_info(call_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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

def patch_calls_call_id_participants_participant_id_with_http_info(call_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_calls_call_id_participants_participant_id ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling patch_calls_call_id_participants_participant_id" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_calls_call_id_participants_participant_id" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants/{participantId}".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_calls_call_id_with_http_info(call_id, opts = {}) ⇒ Array<(Conversation, Fixnum, Hash)>

Update conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Conversation data, response status code and response headers



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

def patch_calls_call_id_with_http_info(call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_calls_call_id ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling patch_calls_call_id" if call_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Conversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#patch_calls_call_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_chats_chat_id_participants_participant_id(chat_id, participant_id, opts = {}) ⇒ nil

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1910
1911
1912
1913
 
# File 'lib/purecloud/api/conversations_api.rb', line 1910

def patch_chats_chat_id_participants_participant_id(chat_id, participant_id, opts = {})
  patch_chats_chat_id_participants_participant_id_with_http_info(chat_id, participant_id, opts)
  return nil
end

#patch_chats_chat_id_participants_participant_id_attributes(chat_id, participant_id, opts = {}) ⇒ nil

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1977
1978
1979
1980
 
# File 'lib/purecloud/api/conversations_api.rb', line 1977

def patch_chats_chat_id_participants_participant_id_attributes(chat_id, participant_id, opts = {})
  patch_chats_chat_id_participants_participant_id_attributes_with_http_info(chat_id, participant_id, opts)
  return nil
end

#patch_chats_chat_id_participants_participant_id_attributes_with_http_info(chat_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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

def patch_chats_chat_id_participants_participant_id_attributes_with_http_info(chat_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_chats_chat_id_participants_participant_id_attributes ..."
  end
  
  # verify the required parameter 'chat_id' is set
  fail "Missing the required parameter 'chat_id' when calling patch_chats_chat_id_participants_participant_id_attributes" if chat_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_chats_chat_id_participants_participant_id_attributes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/chats/{chatId}/participants/{participantId}/attributes".sub('{format}','json').sub('{' + 'chatId' + '}', chat_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_chats_chat_id_participants_participant_id_with_http_info(chat_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'lib/purecloud/api/conversations_api.rb', line 1922

def patch_chats_chat_id_participants_participant_id_with_http_info(chat_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_chats_chat_id_participants_participant_id ..."
  end
  
  # verify the required parameter 'chat_id' is set
  fail "Missing the required parameter 'chat_id' when calling patch_chats_chat_id_participants_participant_id" if chat_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_chats_chat_id_participants_participant_id" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/chats/{chatId}/participants/{participantId}".sub('{format}','json').sub('{' + 'chatId' + '}', chat_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_conversation_id_participants_participant_id(conversation_id, participant_id, opts = {}) ⇒ nil

Update a participant. Update conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3651
3652
3653
3654
 
# File 'lib/purecloud/api/conversations_api.rb', line 3651

def patch_conversation_id_participants_participant_id(conversation_id, participant_id, opts = {})
  patch_conversation_id_participants_participant_id_with_http_info(conversation_id, participant_id, opts)
  return nil
end

#patch_conversation_id_participants_participant_id_attributes(conversation_id, participant_id, opts = {}) ⇒ nil

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3718
3719
3720
3721
 
# File 'lib/purecloud/api/conversations_api.rb', line 3718

def patch_conversation_id_participants_participant_id_attributes(conversation_id, participant_id, opts = {})
  patch_conversation_id_participants_participant_id_attributes_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
 
# File 'lib/purecloud/api/conversations_api.rb', line 3730

def patch_conversation_id_participants_participant_id_attributes_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_conversation_id_participants_participant_id_attributes ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling patch_conversation_id_participants_participant_id_attributes" if conversation_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_conversation_id_participants_participant_id_attributes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/{conversationId}/participants/{participantId}/attributes".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

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

Update a participant. Update conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
 
# File 'lib/purecloud/api/conversations_api.rb', line 3663

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_emails_email_id_participants_participant_id(email_id, participant_id, opts = {}) ⇒ nil

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


2743
2744
2745
2746
 
# File 'lib/purecloud/api/conversations_api.rb', line 2743

def patch_emails_email_id_participants_participant_id(email_id, participant_id, opts = {})
  patch_emails_email_id_participants_participant_id_with_http_info(email_id, participant_id, opts)
  return nil
end

#patch_emails_email_id_participants_participant_id_attributes(email_id, participant_id, opts = {}) ⇒ nil

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


2810
2811
2812
2813
 
# File 'lib/purecloud/api/conversations_api.rb', line 2810

def patch_emails_email_id_participants_participant_id_attributes(email_id, participant_id, opts = {})
  patch_emails_email_id_participants_participant_id_attributes_with_http_info(email_id, participant_id, opts)
  return nil
end

#patch_emails_email_id_participants_participant_id_attributes_with_http_info(email_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
 
# File 'lib/purecloud/api/conversations_api.rb', line 2822

def patch_emails_email_id_participants_participant_id_attributes_with_http_info(email_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_emails_email_id_participants_participant_id_attributes ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling patch_emails_email_id_participants_participant_id_attributes" if email_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_emails_email_id_participants_participant_id_attributes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/participants/{participantId}/attributes".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_emails_email_id_participants_participant_id_with_http_info(email_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
 
# File 'lib/purecloud/api/conversations_api.rb', line 2755

def patch_emails_email_id_participants_participant_id_with_http_info(email_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_emails_email_id_participants_participant_id ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling patch_emails_email_id_participants_participant_id" if email_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_emails_email_id_participants_participant_id" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/participants/{participantId}".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_videos_video_id_participants_participant_id(video_id, participant_id, opts = {}) ⇒ nil

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3254
3255
3256
3257
 
# File 'lib/purecloud/api/conversations_api.rb', line 3254

def patch_videos_video_id_participants_participant_id(video_id, participant_id, opts = {})
  patch_videos_video_id_participants_participant_id_with_http_info(video_id, participant_id, opts)
  return nil
end

#patch_videos_video_id_participants_participant_id_attributes(video_id, participant_id, opts = {}) ⇒ nil

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3321
3322
3323
3324
 
# File 'lib/purecloud/api/conversations_api.rb', line 3321

def patch_videos_video_id_participants_participant_id_attributes(video_id, participant_id, opts = {})
  patch_videos_video_id_participants_participant_id_attributes_with_http_info(video_id, participant_id, opts)
  return nil
end

#patch_videos_video_id_participants_participant_id_attributes_with_http_info(video_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the attributes on a conversation participant.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
 
# File 'lib/purecloud/api/conversations_api.rb', line 3333

def patch_videos_video_id_participants_participant_id_attributes_with_http_info(video_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_videos_video_id_participants_participant_id_attributes ..."
  end
  
  # verify the required parameter 'video_id' is set
  fail "Missing the required parameter 'video_id' when calling patch_videos_video_id_participants_participant_id_attributes" if video_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_videos_video_id_participants_participant_id_attributes" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/videos/{videoId}/participants/{participantId}/attributes".sub('{format}','json').sub('{' + 'videoId' + '}', video_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#patch_videos_video_id_participants_participant_id_with_http_info(video_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update conversation participant

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
 
# File 'lib/purecloud/api/conversations_api.rb', line 3266

def patch_videos_video_id_participants_participant_id_with_http_info(video_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_videos_video_id_participants_participant_id ..."
  end
  
  # verify the required parameter 'video_id' is set
  fail "Missing the required parameter 'video_id' when calling patch_videos_video_id_participants_participant_id" if video_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_videos_video_id_participants_participant_id" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/videos/{videoId}/participants/{participantId}".sub('{format}','json').sub('{' + 'videoId' + '}', video_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

#post_callbacks_callback_id_participants_participant_id_replace(callback_id, participant_id, opts = {}) ⇒ nil

Replace this participant with the specified user and/or address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


568
569
570
571
 
# File 'lib/purecloud/api/conversations_api.rb', line 568

def post_callbacks_callback_id_participants_participant_id_replace(callback_id, participant_id, opts = {})
  post_callbacks_callback_id_participants_participant_id_replace_with_http_info(callback_id, participant_id, opts)
  return nil
end

#post_callbacks_callback_id_participants_participant_id_replace_with_http_info(callback_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Replace this participant with the specified user and/or address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/purecloud/api/conversations_api.rb', line 580

def post_callbacks_callback_id_participants_participant_id_replace_with_http_info(callback_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_callbacks_callback_id_participants_participant_id_replace ..."
  end
  
  # verify the required parameter 'callback_id' is set
  fail "Missing the required parameter 'callback_id' when calling post_callbacks_callback_id_participants_participant_id_replace" if callback_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_callbacks_callback_id_participants_participant_id_replace" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/replace".sub('{format}','json').sub('{' + 'callbackId' + '}', callback_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_callbacks_callback_id_participants_participant_id_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_calls(opts = {}) ⇒ CreateCallResponse

Create a call conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



824
825
826
827
 
# File 'lib/purecloud/api/conversations_api.rb', line 824

def post_calls(opts = {})
  data, status_code, headers = post_calls_with_http_info(opts)
  return data
end

#post_calls_call_id(call_id, opts = {}) ⇒ Conversation

Add a new call to a conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1000
1001
1002
1003
 
# File 'lib/purecloud/api/conversations_api.rb', line 1000

def post_calls_call_id(call_id, opts = {})
  data, status_code, headers = post_calls_call_id_with_http_info(call_id, opts)
  return data
end

#post_calls_call_id_participants(call_id, opts = {}) ⇒ Conversation

Add participants to a conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1126
1127
1128
1129
 
# File 'lib/purecloud/api/conversations_api.rb', line 1126

def post_calls_call_id_participants(call_id, opts = {})
  data, status_code, headers = post_calls_call_id_participants_with_http_info(call_id, opts)
  return data
end

#post_calls_call_id_participants_participant_id_consult(call_id, participant_id, opts = {}) ⇒ ConsultTransferResponse

Initiate and update consult transfer

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1324
1325
1326
1327
 
# File 'lib/purecloud/api/conversations_api.rb', line 1324

def post_calls_call_id_participants_participant_id_consult(call_id, participant_id, opts = {})
  data, status_code, headers = post_calls_call_id_participants_participant_id_consult_with_http_info(call_id, participant_id, opts)
  return data
end

#post_calls_call_id_participants_participant_id_consult_with_http_info(call_id, participant_id, opts = {}) ⇒ Array<(ConsultTransferResponse, Fixnum, Hash)>

Initiate and update consult transfer

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ConsultTransferResponse data, response status code and response headers



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

def post_calls_call_id_participants_participant_id_consult_with_http_info(call_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_calls_call_id_participants_participant_id_consult ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling post_calls_call_id_participants_participant_id_consult" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_calls_call_id_participants_participant_id_consult" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants/{participantId}/consult".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConsultTransferResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_calls_call_id_participants_participant_id_consult\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_calls_call_id_participants_participant_id_monitor(call_id, participant_id, opts = {}) ⇒ nil

Listen in on the conversation from the point of view of a given participant.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1525
1526
1527
1528
 
# File 'lib/purecloud/api/conversations_api.rb', line 1525

def post_calls_call_id_participants_participant_id_monitor(call_id, participant_id, opts = {})
  post_calls_call_id_participants_participant_id_monitor_with_http_info(call_id, participant_id, opts)
  return nil
end

#post_calls_call_id_participants_participant_id_monitor_with_http_info(call_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Listen in on the conversation from the point of view of a given participant.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
 
# File 'lib/purecloud/api/conversations_api.rb', line 1536

def post_calls_call_id_participants_participant_id_monitor_with_http_info(call_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_calls_call_id_participants_participant_id_monitor ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling post_calls_call_id_participants_participant_id_monitor" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_calls_call_id_participants_participant_id_monitor" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants/{participantId}/monitor".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#post_calls_call_id_participants_participant_id_replace(call_id, participant_id, opts = {}) ⇒ nil

Replace this participant with the specified user and/or address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1591
1592
1593
1594
 
# File 'lib/purecloud/api/conversations_api.rb', line 1591

def post_calls_call_id_participants_participant_id_replace(call_id, participant_id, opts = {})
  post_calls_call_id_participants_participant_id_replace_with_http_info(call_id, participant_id, opts)
  return nil
end

#post_calls_call_id_participants_participant_id_replace_with_http_info(call_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Replace this participant with the specified user and/or address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
 
# File 'lib/purecloud/api/conversations_api.rb', line 1603

def post_calls_call_id_participants_participant_id_replace_with_http_info(call_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_calls_call_id_participants_participant_id_replace ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling post_calls_call_id_participants_participant_id_replace" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_calls_call_id_participants_participant_id_replace" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants/{participantId}/replace".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_calls_call_id_participants_participant_id_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_calls_call_id_participants_with_http_info(call_id, opts = {}) ⇒ Array<(Conversation, Fixnum, Hash)>

Add participants to a conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Conversation data, response status code and response headers



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
 
# File 'lib/purecloud/api/conversations_api.rb', line 1137

def post_calls_call_id_participants_with_http_info(call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_calls_call_id_participants ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling post_calls_call_id_participants" if call_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}/participants".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Conversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_calls_call_id_participants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_calls_call_id_with_http_info(call_id, opts = {}) ⇒ Array<(Conversation, Fixnum, Hash)>

Add a new call to a conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Conversation data, response status code and response headers



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

def post_calls_call_id_with_http_info(call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_calls_call_id ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling post_calls_call_id" if call_id.nil?
  
  # resource path
  path = "/api/v2/conversations/calls/{callId}".sub('{format}','json').sub('{' + 'callId' + '}', call_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Conversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_calls_call_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_calls_with_http_info(opts = {}) ⇒ Array<(CreateCallResponse, Fixnum, Hash)>

Create a call conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CreateCallResponse data, response status code and response headers



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

def post_calls_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_calls ..."
  end
  
  # resource path
  path = "/api/v2/conversations/calls".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateCallResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_chats_chat_id_participants_participant_id_replace(chat_id, participant_id, opts = {}) ⇒ nil

Replace this participant with the specified user and/or address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


2044
2045
2046
2047
 
# File 'lib/purecloud/api/conversations_api.rb', line 2044

def post_chats_chat_id_participants_participant_id_replace(chat_id, participant_id, opts = {})
  post_chats_chat_id_participants_participant_id_replace_with_http_info(chat_id, participant_id, opts)
  return nil
end

#post_chats_chat_id_participants_participant_id_replace_with_http_info(chat_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Replace this participant with the specified user and/or address

Parameters:

  • chat_id
  • participant_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
 
# File 'lib/purecloud/api/conversations_api.rb', line 2056

def post_chats_chat_id_participants_participant_id_replace_with_http_info(chat_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_chats_chat_id_participants_participant_id_replace ..."
  end
  
  # verify the required parameter 'chat_id' is set
  fail "Missing the required parameter 'chat_id' when calling post_chats_chat_id_participants_participant_id_replace" if chat_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_chats_chat_id_participants_participant_id_replace" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/chats/{chatId}/participants/{participantId}/replace".sub('{format}','json').sub('{' + 'chatId' + '}', chat_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_chats_chat_id_participants_participant_id_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversation_id_participants_participant_id_callbacks(conversation_id, participant_id, opts = {}) ⇒ nil

Create a new callback for the specified participant on the conversation.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3785
3786
3787
3788
 
# File 'lib/purecloud/api/conversations_api.rb', line 3785

def post_conversation_id_participants_participant_id_callbacks(conversation_id, participant_id, opts = {})
  post_conversation_id_participants_participant_id_callbacks_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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

Create a new callback for the specified participant on the conversation.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
 
# File 'lib/purecloud/api/conversations_api.rb', line 3797

def post_conversation_id_participants_participant_id_callbacks_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_conversation_id_participants_participant_id_callbacks ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling post_conversation_id_participants_participant_id_callbacks" if conversation_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_conversation_id_participants_participant_id_callbacks" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_conversation_id_participants_participant_id_callbacks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversation_id_participants_participant_id_replace(conversation_id, participant_id, opts = {}) ⇒ nil

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3852
3853
3854
3855
 
# File 'lib/purecloud/api/conversations_api.rb', line 3852

def post_conversation_id_participants_participant_id_replace(conversation_id, participant_id, opts = {})
  post_conversation_id_participants_participant_id_replace_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
 
# File 'lib/purecloud/api/conversations_api.rb', line 3864

def post_conversation_id_participants_participant_id_replace_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_conversation_id_participants_participant_id_replace ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling post_conversation_id_participants_participant_id_replace" if conversation_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_conversation_id_participants_participant_id_replace" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/{conversationId}/participants/{participantId}/replace".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_conversation_id_participants_participant_id_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversations_aggregates_query(opts = {}) ⇒ AggregateQueryResponse

Query for conversation aggregates

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



16
17
18
19
 
# File 'lib/purecloud/api/conversations_api.rb', line 16

def post_conversations_aggregates_query(opts = {})
  data, status_code, headers = post_conversations_aggregates_query_with_http_info(opts)
  return data
end

#post_conversations_aggregates_query_with_http_info(opts = {}) ⇒ Array<(AggregateQueryResponse, Fixnum, Hash)>

Query for conversation aggregates

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    AggregateQueryResponse data, response status code and response headers



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/purecloud/api/conversations_api.rb', line 26

def post_conversations_aggregates_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_conversations_aggregates_query ..."
  end
  
  # resource path
  path = "/api/v2/analytics/conversations/aggregates/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AggregateQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversations_conversation_id_details_properties(conversation_id, opts = {}) ⇒ PropertyIndexRequest

Index conversation properties

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Options Hash (opts):

Returns:



194
195
196
197
 
# File 'lib/purecloud/api/conversations_api.rb', line 194

def post_conversations_conversation_id_details_properties(conversation_id, opts = {})
  data, status_code, headers = post_conversations_conversation_id_details_properties_with_http_info(conversation_id, opts)
  return data
end

#post_conversations_conversation_id_details_properties_with_http_info(conversation_id, opts = {}) ⇒ Array<(PropertyIndexRequest, Fixnum, Hash)>

Index conversation properties

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PropertyIndexRequest data, response status code and response headers



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/purecloud/api/conversations_api.rb', line 205

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PropertyIndexRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_conversation_id_details_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversations_details_query(opts = {}) ⇒ AnalyticsConversationQueryResponse

Query for conversation details

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



74
75
76
77
 
# File 'lib/purecloud/api/conversations_api.rb', line 74

def post_conversations_details_query(opts = {})
  data, status_code, headers = post_conversations_details_query_with_http_info(opts)
  return data
end

#post_conversations_details_query_with_http_info(opts = {}) ⇒ Array<(AnalyticsConversationQueryResponse, Fixnum, Hash)>

Query for conversation details

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/purecloud/api/conversations_api.rb', line 84

def post_conversations_details_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_conversations_details_query ..."
  end
  
  # resource path
  path = "/api/v2/analytics/conversations/details/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AnalyticsConversationQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_details_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_emails_email_id_messages(email_id, opts = {}) ⇒ EmailMessage

Send an email reply

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2423
2424
2425
2426
 
# File 'lib/purecloud/api/conversations_api.rb', line 2423

def post_emails_email_id_messages(email_id, opts = {})
  data, status_code, headers = post_emails_email_id_messages_with_http_info(email_id, opts)
  return data
end

#post_emails_email_id_messages_with_http_info(email_id, opts = {}) ⇒ Array<(EmailMessage, Fixnum, Hash)>

Send an email reply

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EmailMessage data, response status code and response headers



2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
 
# File 'lib/purecloud/api/conversations_api.rb', line 2434

def post_emails_email_id_messages_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_emails_email_id_messages ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling post_emails_email_id_messages" if email_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/messages".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_emails_email_id_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_emails_email_id_participants_participant_id_replace(email_id, participant_id, opts = {}) ⇒ nil

Replace this participant with the specified user and/or address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


2877
2878
2879
2880
 
# File 'lib/purecloud/api/conversations_api.rb', line 2877

def post_emails_email_id_participants_participant_id_replace(email_id, participant_id, opts = {})
  post_emails_email_id_participants_participant_id_replace_with_http_info(email_id, participant_id, opts)
  return nil
end

#post_emails_email_id_participants_participant_id_replace_with_http_info(email_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Replace this participant with the specified user and/or address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
 
# File 'lib/purecloud/api/conversations_api.rb', line 2889

def post_emails_email_id_participants_participant_id_replace_with_http_info(email_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_emails_email_id_participants_participant_id_replace ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling post_emails_email_id_participants_participant_id_replace" if email_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_emails_email_id_participants_participant_id_replace" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/participants/{participantId}/replace".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_emails_email_id_participants_participant_id_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_faxes(opts = {}) ⇒ FaxSendResponse

Create Fax Conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3077
3078
3079
3080
 
# File 'lib/purecloud/api/conversations_api.rb', line 3077

def post_faxes(opts = {})
  data, status_code, headers = post_faxes_with_http_info(opts)
  return data
end

#post_faxes_with_http_info(opts = {}) ⇒ Array<(FaxSendResponse, Fixnum, Hash)>

Create Fax Conversation

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    FaxSendResponse data, response status code and response headers



3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
 
# File 'lib/purecloud/api/conversations_api.rb', line 3087

def post_faxes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_faxes ..."
  end
  
  # resource path
  path = "/api/v2/conversations/faxes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FaxSendResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_faxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_videos_video_id_participants_participant_id_replace(video_id, participant_id, opts = {}) ⇒ nil

Replace this participant with the specified user and/or address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3388
3389
3390
3391
 
# File 'lib/purecloud/api/conversations_api.rb', line 3388

def post_videos_video_id_participants_participant_id_replace(video_id, participant_id, opts = {})
  post_videos_video_id_participants_participant_id_replace_with_http_info(video_id, participant_id, opts)
  return nil
end

#post_videos_video_id_participants_participant_id_replace_with_http_info(video_id, participant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Replace this participant with the specified user and/or address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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

def post_videos_video_id_participants_participant_id_replace_with_http_info(video_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_videos_video_id_participants_participant_id_replace ..."
  end
  
  # verify the required parameter 'video_id' is set
  fail "Missing the required parameter 'video_id' when calling post_videos_video_id_participants_participant_id_replace" if video_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_videos_video_id_participants_participant_id_replace" if participant_id.nil?
  
  # resource path
  path = "/api/v2/conversations/videos/{videoId}/participants/{participantId}/replace".sub('{format}','json').sub('{' + 'videoId' + '}', video_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_videos_video_id_participants_participant_id_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_emails_email_id_messages_draft(email_id, opts = {}) ⇒ EmailMessage

Update conversation draft reply

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2547
2548
2549
2550
 
# File 'lib/purecloud/api/conversations_api.rb', line 2547

def put_emails_email_id_messages_draft(email_id, opts = {})
  data, status_code, headers = put_emails_email_id_messages_draft_with_http_info(email_id, opts)
  return data
end

#put_emails_email_id_messages_draft_with_http_info(email_id, opts = {}) ⇒ Array<(EmailMessage, Fixnum, Hash)>

Update conversation draft reply

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EmailMessage data, response status code and response headers



2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
 
# File 'lib/purecloud/api/conversations_api.rb', line 2558

def put_emails_email_id_messages_draft_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#put_emails_email_id_messages_draft ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling put_emails_email_id_messages_draft" if email_id.nil?
  
  # resource path
  path = "/api/v2/conversations/emails/{emailId}/messages/draft".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#put_emails_email_id_messages_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end