Class: PureCloud::ConversationsApi

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



23
24
25
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

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

Delete a code used to add a communication to this participant

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • add_communication_code —

    addCommunicationCode

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

    the optional parameters

Returns:

  • (nil) 


34
35
36
37
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 34

def delete_conversation_participant_code(conversation_id, participant_id, add_communication_code, opts = {})
  delete_conversation_participant_code_with_http_info(conversation_id, participant_id, add_communication_code, opts)
  return nil
end

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

Delete a code used to add a communication to this participant

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • add_communication_code —

    addCommunicationCode

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 46

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Cancel the transfer

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

  • (nil) 


117
118
119
120
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 117

def delete_conversations_call_participant_consult(conversation_id, participant_id, opts = {})
  delete_conversations_call_participant_consult_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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

Cancel the transfer

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 128

def delete_conversations_call_participant_consult_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.delete_conversations_call_participant_consult ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.delete_conversations_call_participant_consult" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.delete_conversations_call_participant_consult" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult".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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#delete_conversations_email_messages_draft_attachment(conversation_id, attachment_id, opts = {}) ⇒ nil

Delete attachment from draft

Parameters:

  • conversation_id —

    conversationId

  • attachment_id —

    attachmentId

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

    the optional parameters

Returns:

  • (nil) 


191
192
193
194
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 191

def delete_conversations_email_messages_draft_attachment(conversation_id, attachment_id, opts = {})
  delete_conversations_email_messages_draft_attachment_with_http_info(conversation_id, attachment_id, opts)
  return nil
end

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

Delete attachment from draft

Parameters:

  • conversation_id —

    conversationId

  • attachment_id —

    attachmentId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get a conversation by id

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



264
265
266
267
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 264

def get_analytics_conversation_details(conversation_id, opts = {})
  data, _status_code, _headers = get_analytics_conversation_details_with_http_info(conversation_id, opts)
  return data
end

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 274

def get_analytics_conversation_details_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_analytics_conversation_details ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_analytics_conversation_details" if conversation_id.nil?
  
  
  
  
  
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Get conversation

Parameters:

  • conversation_id —

    conversation ID

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

    the optional parameters

Returns:



329
330
331
332
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 329

def get_conversation(conversation_id, opts = {})
  data, _status_code, _headers = get_conversation_with_http_info(conversation_id, opts)
  return data
end

#get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id, opts = {}) ⇒ SecureSession

Fetch info on a secure session

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • secure_session_id —

    secure IVR session ID

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

    the optional parameters

Returns:



396
397
398
399
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 396

def get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id, opts = {})
  data, _status_code, _headers = get_conversation_participant_secureivrsession_with_http_info(conversation_id, participant_id, secure_session_id, opts)
  return data
end

#get_conversation_participant_secureivrsession_with_http_info(conversation_id, participant_id, secure_session_id, opts = {}) ⇒ Array<(SecureSession, Fixnum, Hash)>

Fetch info on a secure session

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • secure_session_id —

    secure IVR session ID

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

    the optional parameters

Returns:

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

    SecureSession data, response status code and response headers



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 408

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversation_participant_secureivrsessions(conversation_id, participant_id, opts = {}) ⇒ SecureSessionEntityListing

Get a list of secure sessions for this participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Returns:



480
481
482
483
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 480

def get_conversation_participant_secureivrsessions(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversation_participant_secureivrsessions_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get a list of secure sessions for this participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Returns:

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

    SecureSessionEntityListing data, response status code and response headers



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 491

def get_conversation_participant_secureivrsessions_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversation_participant_secureivrsessions ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversation_participant_secureivrsessions" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversation_participant_secureivrsessions" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions".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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversation_participant_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. (default to false)

Returns:



556
557
558
559
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 556

def get_conversation_participant_wrapup(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversation_participant_wrapup_with_http_info(conversation_id, participant_id, opts)
  return data
end

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



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 568

def get_conversation_participant_wrapup_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversation_participant_wrapup ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversation_participant_wrapup" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversation_participant_wrapup" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversation_participant_wrapupcodes(conversation_id, participant_id, opts = {}) ⇒ Array<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:



639
640
641
642
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 639

def get_conversation_participant_wrapupcodes(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversation_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts)
  return data
end

#get_conversation_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {}) ⇒ Array<(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<(Array<WrapupCode>, Fixnum, Hash)>) —

    Array<WrapupCode> data, response status code and response headers



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
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 650

def get_conversation_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversation_participant_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversation_participant_wrapupcodes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversation_participant_wrapupcodes" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 339

def get_conversation_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversation ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversation" if conversation_id.nil?
  
  
  
  
  
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Conversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversation\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:



713
714
715
716
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 713

def get_conversations(opts = {})
  data, _status_code, _headers = get_conversations_with_http_info(opts)
  return data
end

#get_conversations_call(conversation_id, opts = {}) ⇒ CallConversation

Get call conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



777
778
779
780
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 777

def get_conversations_call(conversation_id, opts = {})
  data, _status_code, _headers = get_conversations_call_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_call_participant_wrapup(conversation_id, participant_id, opts = {}) ⇒ Wrapup

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional. (default to false)

Returns:



844
845
846
847
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 844

def get_conversations_call_participant_wrapup(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_call_participant_wrapup_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    Wrapup data, response status code and response headers



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 856

def get_conversations_call_participant_wrapup_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_call_participant_wrapup ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_call_participant_wrapup" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_call_participant_wrapup" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_call_participant_wrapupcodes(conversation_id, participant_id, opts = {}) ⇒ Array<WrapupCode>

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



927
928
929
930
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 927

def get_conversations_call_participant_wrapupcodes(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_call_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

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

    Array<WrapupCode> data, response status code and response headers



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

def get_conversations_call_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_call_participant_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_call_participant_wrapupcodes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_call_participant_wrapupcodes" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_call_with_http_info(conversation_id, opts = {}) ⇒ Array<(CallConversation, Fixnum, Hash)>

Get call conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    CallConversation data, response status code and response headers



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
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 787

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_callback(conversation_id, opts = {}) ⇒ CallbackConversation

Get callback conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



1001
1002
1003
1004
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1001

def get_conversations_callback(conversation_id, opts = {})
  data, _status_code, _headers = get_conversations_callback_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_callback_participant_wrapup(conversation_id, participant_id, opts = {}) ⇒ Wrapup

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional. (default to false)

Returns:



1068
1069
1070
1071
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1068

def get_conversations_callback_participant_wrapup(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_callback_participant_wrapup_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    Wrapup data, response status code and response headers



1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1080

def get_conversations_callback_participant_wrapup_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_callback_participant_wrapup ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_callback_participant_wrapup" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_callback_participant_wrapup" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/callbacks/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id, opts = {}) ⇒ Array<WrapupCode>

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



1151
1152
1153
1154
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1151

def get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_callback_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

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

    Array<WrapupCode> data, response status code and response headers



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1162

def get_conversations_callback_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_callback_participant_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_callback_participant_wrapupcodes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_callback_participant_wrapupcodes" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/callbacks/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_callback_with_http_info(conversation_id, opts = {}) ⇒ Array<(CallbackConversation, Fixnum, Hash)>

Get callback conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    CallbackConversation 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
1056
1057
1058
1059
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1011

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_callbacks(opts = {}) ⇒ CallbackConversationEntityListing

Get callback conversations

Parameters:

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

    the optional parameters

Returns:



1224
1225
1226
1227
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1224

def get_conversations_callbacks(opts = {})
  data, _status_code, _headers = get_conversations_callbacks_with_http_info(opts)
  return data
end

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

Get callback conversations

Parameters:

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

    the optional parameters

Returns:



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1233

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_calls(opts = {}) ⇒ CallConversationEntityListing

Get recent conversations

Parameters:

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

    the optional parameters

Returns:



1279
1280
1281
1282
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1279

def get_conversations_calls(opts = {})
  data, _status_code, _headers = get_conversations_calls_with_http_info(opts)
  return data
end

#get_conversations_calls_history(opts = {}) ⇒ CallHistoryConversationEntityListing

Get call history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size, maximum 50 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :interval (String) —

    Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39;

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:



1338
1339
1340
1341
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1338

def get_conversations_calls_history(opts = {})
  data, _status_code, _headers = get_conversations_calls_history_with_http_info(opts)
  return data
end

#get_conversations_calls_history_with_http_info(opts = {}) ⇒ Array<(CallHistoryConversationEntityListing, Fixnum, Hash)>

Get call history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size, maximum 50

  • :page_number (Integer) —

    Page number

  • :interval (String) —

    Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39;

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1351

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_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:



1425
1426
1427
1428
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1425

def get_conversations_calls_maximumconferenceparties(opts = {})
  data, _status_code, _headers = get_conversations_calls_maximumconferenceparties_with_http_info(opts)
  return data
end

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



1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1434

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get recent conversations

Parameters:

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

    the optional parameters

Returns:



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_chat(conversation_id, opts = {}) ⇒ ChatConversation

Get chat conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



1481
1482
1483
1484
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1481

def get_conversations_chat(conversation_id, opts = {})
  data, _status_code, _headers = get_conversations_chat_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_chat_participant_wrapup(conversation_id, participant_id, opts = {}) ⇒ Wrapup

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional. (default to false)

Returns:



1548
1549
1550
1551
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1548

def get_conversations_chat_participant_wrapup(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_chat_participant_wrapup_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    Wrapup data, response status code and response headers



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

def get_conversations_chat_participant_wrapup_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_chat_participant_wrapup ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_chat_participant_wrapup" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_chat_participant_wrapup" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/chats/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_chat_participant_wrapupcodes(conversation_id, participant_id, opts = {}) ⇒ Array<WrapupCode>

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



1631
1632
1633
1634
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1631

def get_conversations_chat_participant_wrapupcodes(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_chat_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

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

    Array<WrapupCode> data, response status code and response headers



1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1642

def get_conversations_chat_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_chat_participant_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_chat_participant_wrapupcodes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_chat_participant_wrapupcodes" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/chats/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_chat_with_http_info(conversation_id, opts = {}) ⇒ Array<(ChatConversation, Fixnum, Hash)>

Get chat conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    ChatConversation data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_chats(opts = {}) ⇒ ChatConversationEntityListing

Get recent chat conversations

Parameters:

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

    the optional parameters

Returns:



1704
1705
1706
1707
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1704

def get_conversations_chats(opts = {})
  data, _status_code, _headers = get_conversations_chats_with_http_info(opts)
  return data
end

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

Get recent chat conversations

Parameters:

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

    the optional parameters

Returns:



1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1713

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_cobrowsesession(conversation_id, opts = {}) ⇒ CobrowseConversation

Get cobrowse conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



1760
1761
1762
1763
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1760

def get_conversations_cobrowsesession(conversation_id, opts = {})
  data, _status_code, _headers = get_conversations_cobrowsesession_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_cobrowsesession_participant_wrapup(conversation_id, participant_id, opts = {}) ⇒ Wrapup

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional. (default to false)

Returns:



1827
1828
1829
1830
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1827

def get_conversations_cobrowsesession_participant_wrapup(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_cobrowsesession_participant_wrapup_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    Wrapup data, response status code and response headers



1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1839

def get_conversations_cobrowsesession_participant_wrapup_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_cobrowsesession_participant_wrapup ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_cobrowsesession_participant_wrapup" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_cobrowsesession_participant_wrapup" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/cobrowsesessions/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_cobrowsesession_participant_wrapupcodes(conversation_id, participant_id, opts = {}) ⇒ Array<WrapupCode>

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



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

def get_conversations_cobrowsesession_participant_wrapupcodes(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_cobrowsesession_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

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

    Array<WrapupCode> data, response status code and response headers



1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1921

def get_conversations_cobrowsesession_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_cobrowsesession_participant_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_cobrowsesession_participant_wrapupcodes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_cobrowsesession_participant_wrapupcodes" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/cobrowsesessions/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_cobrowsesession_with_http_info(conversation_id, opts = {}) ⇒ Array<(CobrowseConversation, Fixnum, Hash)>

Get cobrowse conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    CobrowseConversation data, response status code and response headers



1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1770

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_cobrowsesessions(opts = {}) ⇒ CobrowseConversationEntityListing

Get recent cobrowse conversations

Parameters:

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

    the optional parameters

Returns:



1983
1984
1985
1986
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 1983

def get_conversations_cobrowsesessions(opts = {})
  data, _status_code, _headers = get_conversations_cobrowsesessions_with_http_info(opts)
  return data
end

#get_conversations_cobrowsesessions_with_http_info(opts = {}) ⇒ Array<(CobrowseConversationEntityListing, Fixnum, Hash)>

Get recent cobrowse conversations

Parameters:

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

    the optional parameters

Returns:



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_email(conversation_id, opts = {}) ⇒ EmailConversation

Get email conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



2039
2040
2041
2042
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2039

def get_conversations_email(conversation_id, opts = {})
  data, _status_code, _headers = get_conversations_email_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_email_message(conversation_id, message_id, opts = {}) ⇒ EmailMessage

Get conversation message

Parameters:

  • conversation_id —

    conversationId

  • message_id —

    messageId

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

    the optional parameters

Returns:



2105
2106
2107
2108
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2105

def get_conversations_email_message(conversation_id, message_id, opts = {})
  data, _status_code, _headers = get_conversations_email_message_with_http_info(conversation_id, message_id, opts)
  return data
end

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

Get conversation message

Parameters:

  • conversation_id —

    conversationId

  • message_id —

    messageId

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



2116
2117
2118
2119
2120
2121
2122
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
2172
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2116

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_email_messages(conversation_id, opts = {}) ⇒ EmailMessageListing

Get conversation messages

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



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

def get_conversations_email_messages(conversation_id, opts = {})
  data, _status_code, _headers = get_conversations_email_messages_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_email_messages_draft(conversation_id, opts = {}) ⇒ EmailMessage

Get conversation draft reply

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



2244
2245
2246
2247
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2244

def get_conversations_email_messages_draft(conversation_id, opts = {})
  data, _status_code, _headers = get_conversations_email_messages_draft_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_email_messages_draft_with_http_info(conversation_id, opts = {}) ⇒ Array<(EmailMessage, Fixnum, Hash)>

Get conversation draft reply

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



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
2294
2295
2296
2297
2298
2299
2300
2301
2302
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2254

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_email_messages_with_http_info(conversation_id, opts = {}) ⇒ Array<(EmailMessageListing, Fixnum, Hash)>

Get conversation messages

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    EmailMessageListing data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_email_participant_wrapup(conversation_id, participant_id, opts = {}) ⇒ Wrapup

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional. (default to false)

Returns:



2311
2312
2313
2314
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2311

def get_conversations_email_participant_wrapup(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_email_participant_wrapup_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    Wrapup data, response status code and response headers



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
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2323

def get_conversations_email_participant_wrapup_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_email_participant_wrapup ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_email_participant_wrapup" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_email_participant_wrapup" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/emails/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_email_participant_wrapupcodes(conversation_id, participant_id, opts = {}) ⇒ Array<WrapupCode>

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



2394
2395
2396
2397
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2394

def get_conversations_email_participant_wrapupcodes(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_email_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

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

    Array<WrapupCode> data, response status code and response headers



2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
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
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2405

def get_conversations_email_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_email_participant_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_email_participant_wrapupcodes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversations_email_participant_wrapupcodes" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/emails/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_conversations_email_with_http_info(conversation_id, opts = {}) ⇒ Array<(EmailConversation, Fixnum, Hash)>

Get email conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    EmailConversation data, response status code and response headers



2049
2050
2051
2052
2053
2054
2055
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
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2049

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_emails(opts = {}) ⇒ EmailConversationEntityListing

Get recent email conversations

Parameters:

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

    the optional parameters

Returns:



2467
2468
2469
2470
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2467

def get_conversations_emails(opts = {})
  data, _status_code, _headers = get_conversations_emails_with_http_info(opts)
  return data
end

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

Get recent email conversations

Parameters:

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

    the optional parameters

Returns:



2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2476

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailConversationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversations_emails\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



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

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
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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

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

Update a participant. Update conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Update request

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

    the optional parameters

Returns:

  • (nil) 


2525
2526
2527
2528
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2525

def patch_conversation_participant(conversation_id, participant_id, body, opts = {})
  patch_conversation_participant_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Participant attributes

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

    the optional parameters

Returns:

  • (nil) 


2609
2610
2611
2612
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2609

def patch_conversation_participant_attributes(conversation_id, participant_id, body, opts = {})
  patch_conversation_participant_attributes_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Participant attributes

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

    the optional parameters

Returns:

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

    nil, 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
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2621

def patch_conversation_participant_attributes_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversation_participant_attributes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversation_participant_attributes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversation_participant_attributes" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversation_participant_attributes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update a participant. Update conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Update request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
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
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2537

def patch_conversation_participant_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversation_participant ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversation_participant" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversation_participant" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversation_participant" if body.nil?
  
  
  
  
  
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_call(conversation_id, body, opts = {}) ⇒ Conversation

Update a conversation by setting it’s recording state, merging in other conversations to create a conference, or disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:



2692
2693
2694
2695
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2692

def patch_conversations_call(conversation_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_call_with_http_info(conversation_id, body, opts)
  return data
end

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant request

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

    the optional parameters

Returns:

  • (nil) 


2768
2769
2770
2771
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2768

def patch_conversations_call_participant(conversation_id, participant_id, body, opts = {})
  patch_conversations_call_participant_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant attributes

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

    the optional parameters

Returns:

  • (nil) 


2852
2853
2854
2855
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2852

def patch_conversations_call_participant_attributes(conversation_id, participant_id, body, opts = {})
  patch_conversations_call_participant_attributes_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant attributes

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
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
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2864

def patch_conversations_call_participant_attributes_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_call_participant_attributes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_call_participant_attributes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_call_participant_attributes" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_call_participant_attributes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



2937
2938
2939
2940
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2937

def patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_call_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts)
  return data
end

#patch_conversations_call_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Update conversation participant&#39;s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



2950
2951
2952
2953
2954
2955
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
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2950

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_conversations_call_participant_consult(conversation_id, participant_id, body, opts = {}) ⇒ ConsultTransferResponse

Change who can speak

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    new speak to

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

    the optional parameters

Returns:



3031
3032
3033
3034
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3031

def patch_conversations_call_participant_consult(conversation_id, participant_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_call_participant_consult_with_http_info(conversation_id, participant_id, body, opts)
  return data
end

#patch_conversations_call_participant_consult_with_http_info(conversation_id, participant_id, body, opts = {}) ⇒ Array<(ConsultTransferResponse, Fixnum, Hash)>

Change who can speak

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    new speak to

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

    the optional parameters

Returns:

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

    ConsultTransferResponse data, response status code and response headers



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
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3043

def patch_conversations_call_participant_consult_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_call_participant_consult ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_call_participant_consult" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_call_participant_consult" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_call_participant_consult" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult".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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_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_conversations_call_participant_consult\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2780

def patch_conversations_call_participant_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_call_participant ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_call_participant" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_call_participant" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_call_participant" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update a conversation by setting it&#39;s recording state, merging in other conversations to create a conference, or disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



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
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 2703

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_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_conversations_call\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_conversations_callback(conversation_id, body, opts = {}) ⇒ Conversation

Update a conversation by disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:



3115
3116
3117
3118
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3115

def patch_conversations_callback(conversation_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_callback_with_http_info(conversation_id, body, opts)
  return data
end

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant

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

    the optional parameters

Returns:

  • (nil) 


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

def patch_conversations_callback_participant(conversation_id, participant_id, body, opts = {})
  patch_conversations_callback_participant_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Attributes

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

    the optional parameters

Returns:

  • (nil) 


3275
3276
3277
3278
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3275

def patch_conversations_callback_participant_attributes(conversation_id, participant_id, body, opts = {})
  patch_conversations_callback_participant_attributes_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Attributes

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3287

def patch_conversations_callback_participant_attributes_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_callback_participant_attributes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_callback_participant_attributes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_callback_participant_attributes" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_callback_participant_attributes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/callbacks/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



3360
3361
3362
3363
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3360

def patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_callback_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts)
  return data
end

#patch_conversations_callback_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Update conversation participant&#39;s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
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
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3373

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3203

def patch_conversations_callback_participant_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_callback_participant ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_callback_participant" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_callback_participant" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_callback_participant" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/callbacks/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update a conversation by disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
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
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3126

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_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_conversations_callback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_conversations_chat(conversation_id, body, opts = {}) ⇒ Conversation

Update a conversation by disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:



3453
3454
3455
3456
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3453

def patch_conversations_chat(conversation_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_chat_with_http_info(conversation_id, body, opts)
  return data
end

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Update request

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

    the optional parameters

Returns:

  • (nil) 


3529
3530
3531
3532
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3529

def patch_conversations_chat_participant(conversation_id, participant_id, body, opts = {})
  patch_conversations_chat_participant_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant attributes

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

    the optional parameters

Returns:

  • (nil) 


3613
3614
3615
3616
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3613

def patch_conversations_chat_participant_attributes(conversation_id, participant_id, body, opts = {})
  patch_conversations_chat_participant_attributes_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant attributes

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
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
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3625

def patch_conversations_chat_participant_attributes_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_chat_participant_attributes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_chat_participant_attributes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_chat_participant_attributes" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_chat_participant_attributes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/chats/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_chat_participant_communication(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



3698
3699
3700
3701
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3698

def patch_conversations_chat_participant_communication(conversation_id, participant_id, communication_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_chat_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts)
  return data
end

#patch_conversations_chat_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Update conversation participant&#39;s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
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
3777
3778
3779
3780
3781
3782
3783
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3711

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Update request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3541

def patch_conversations_chat_participant_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_chat_participant ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_chat_participant" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_chat_participant" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_chat_participant" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/chats/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update a conversation by disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



3464
3465
3466
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
3516
3517
3518
3519
3520
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3464

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_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_conversations_chat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_conversations_cobrowsesession(conversation_id, body, opts = {}) ⇒ Conversation

Update a conversation by disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:



3791
3792
3793
3794
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3791

def patch_conversations_cobrowsesession(conversation_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_cobrowsesession_with_http_info(conversation_id, body, opts)
  return data
end

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3867
3868
3869
3870
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3867

def patch_conversations_cobrowsesession_participant(conversation_id, participant_id, opts = {})
  patch_conversations_cobrowsesession_participant_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3949
3950
3951
3952
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3949

def patch_conversations_cobrowsesession_participant_attributes(conversation_id, participant_id, opts = {})
  patch_conversations_cobrowsesession_participant_attributes_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
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
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3961

def patch_conversations_cobrowsesession_participant_attributes_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_cobrowsesession_participant_attributes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_cobrowsesession_participant_attributes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_cobrowsesession_participant_attributes" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/cobrowsesessions/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_cobrowsesession_participant_communication(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



4032
4033
4034
4035
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4032

def patch_conversations_cobrowsesession_participant_communication(conversation_id, participant_id, communication_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_cobrowsesession_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts)
  return data
end

#patch_conversations_cobrowsesession_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Update conversation participant&#39;s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4045

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3879

def patch_conversations_cobrowsesession_participant_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_cobrowsesession_participant ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_cobrowsesession_participant" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_cobrowsesession_participant" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/cobrowsesessions/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update a conversation by disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



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
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 3802

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_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_conversations_cobrowsesession\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_conversations_email(conversation_id, body, opts = {}) ⇒ Conversation

Update a conversation by disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:



4125
4126
4127
4128
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4125

def patch_conversations_email(conversation_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_email_with_http_info(conversation_id, body, opts)
  return data
end

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Update request

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

    the optional parameters

Returns:

  • (nil) 


4201
4202
4203
4204
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4201

def patch_conversations_email_participant(conversation_id, participant_id, body, opts = {})
  patch_conversations_email_participant_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant attributes

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

    the optional parameters

Returns:

  • (nil) 


4285
4286
4287
4288
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4285

def patch_conversations_email_participant_attributes(conversation_id, participant_id, body, opts = {})
  patch_conversations_email_participant_attributes_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Participant attributes

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4297

def patch_conversations_email_participant_attributes_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_email_participant_attributes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_email_participant_attributes" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_email_participant_attributes" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_email_participant_attributes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/emails/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_email_participant_communication(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



4370
4371
4372
4373
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4370

def patch_conversations_email_participant_communication(conversation_id, participant_id, communication_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_email_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts)
  return data
end

#patch_conversations_email_participant_communication_with_http_info(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Update conversation participant&#39;s communication by disconnecting it.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4383

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update conversation participant

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Update request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4213

def patch_conversations_email_participant_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_email_participant ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_email_participant" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_email_participant" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_email_participant" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/emails/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update a conversation by disconnecting all of the participants

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4136

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_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_conversations_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_analytics_conversation_details_properties(conversation_id, body, opts = {}) ⇒ PropertyIndexRequest

Index conversation properties

Parameters:

  • conversation_id —

    conversationId

  • body —

    request

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

    the optional parameters

Returns:



4463
4464
4465
4466
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4463

def post_analytics_conversation_details_properties(conversation_id, body, opts = {})
  data, _status_code, _headers = post_analytics_conversation_details_properties_with_http_info(conversation_id, body, opts)
  return data
end

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

Index conversation properties

Parameters:

  • conversation_id —

    conversationId

  • body —

    request

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

    the optional parameters

Returns:

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

    PropertyIndexRequest data, response status code and response headers



4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4474

def post_analytics_conversation_details_properties_with_http_info(conversation_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_analytics_conversation_details_properties ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_analytics_conversation_details_properties" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_analytics_conversation_details_properties" if body.nil?
  
  
  
  
  
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#post_analytics_conversations_aggregates_query(body, opts = {}) ⇒ AggregateQueryResponse

Query for conversation aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



4537
4538
4539
4540
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4537

def post_analytics_conversations_aggregates_query(body, opts = {})
  data, _status_code, _headers = post_analytics_conversations_aggregates_query_with_http_info(body, opts)
  return data
end

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

Query for conversation aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:

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

    AggregateQueryResponse data, response status code and response headers



4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4547

def post_analytics_conversations_aggregates_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_analytics_conversations_aggregates_query ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_analytics_conversations_aggregates_query" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/analytics/conversations/aggregates/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_analytics_conversations_details_query(body, opts = {}) ⇒ AnalyticsConversationQueryResponse

Query for conversation details

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



4602
4603
4604
4605
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4602

def post_analytics_conversations_details_query(body, opts = {})
  data, _status_code, _headers = post_analytics_conversations_details_query_with_http_info(body, opts)
  return data
end

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

Query for conversation details

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4612

def post_analytics_conversations_details_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_analytics_conversations_details_query ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_analytics_conversations_details_query" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/analytics/conversations/details/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_conversation_participant_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) 


4669
4670
4671
4672
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4669

def post_conversation_participant_callbacks(conversation_id, participant_id, opts = {})
  post_conversation_participant_callbacks_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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



4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4681

def post_conversation_participant_callbacks_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversation_participant_callbacks ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversation_participant_callbacks" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversation_participant_callbacks" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Sends DTMF to the participant

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


4751
4752
4753
4754
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4751

def post_conversation_participant_digits(conversation_id, participant_id, opts = {})
  post_conversation_participant_digits_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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

Sends DTMF to the 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



4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4763

def post_conversation_participant_digits_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversation_participant_digits ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversation_participant_digits" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversation_participant_digits" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/participants/{participantId}/digits".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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Transfer request

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

    the optional parameters

Returns:

  • (nil) 


4833
4834
4835
4836
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4833

def post_conversation_participant_replace(conversation_id, participant_id, body, opts = {})
  post_conversation_participant_replace_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Transfer request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4845

def post_conversation_participant_replace_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversation_participant_replace ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversation_participant_replace" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversation_participant_replace" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversation_participant_replace" if body.nil?
  
  
  
  
  
  # resource path
  local_var_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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#post_conversation_participant_secureivrsessions(conversation_id, participant_id, opts = {}) ⇒ SecureSession

Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:



4917
4918
4919
4920
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4917

def post_conversation_participant_secureivrsessions(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = post_conversation_participant_secureivrsessions_with_http_info(conversation_id, participant_id, opts)
  return data
end

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

Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SecureSession data, response status code and response headers



4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4929

def post_conversation_participant_secureivrsessions_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversation_participant_secureivrsessions ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversation_participant_secureivrsessions" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversation_participant_secureivrsessions" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions".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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#post_conversations_call(conversation_id, body, opts = {}) ⇒ Conversation

Place a new call as part of a callback conversation.

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:



4999
5000
5001
5002
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 4999

def post_conversations_call(conversation_id, body, opts = {})
  data, _status_code, _headers = post_conversations_call_with_http_info(conversation_id, body, opts)
  return data
end

#post_conversations_call_participant_consult(conversation_id, participant_id, body, opts = {}) ⇒ ConsultTransferResponse

Initiate and update consult transfer

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Destination address &amp; initial speak to

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

    the optional parameters

Returns:



5075
5076
5077
5078
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5075

def post_conversations_call_participant_consult(conversation_id, participant_id, body, opts = {})
  data, _status_code, _headers = post_conversations_call_participant_consult_with_http_info(conversation_id, participant_id, body, opts)
  return data
end

#post_conversations_call_participant_consult_with_http_info(conversation_id, participant_id, body, opts = {}) ⇒ Array<(ConsultTransferResponse, Fixnum, Hash)>

Initiate and update consult transfer

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Destination address &amp; initial speak to

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

    the optional parameters

Returns:

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

    ConsultTransferResponse data, response status code and response headers



5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5087

def post_conversations_call_participant_consult_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_call_participant_consult ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_call_participant_consult" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversations_call_participant_consult" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_call_participant_consult" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult".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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

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

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

  • (nil) 


5159
5160
5161
5162
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5159

def post_conversations_call_participant_monitor(conversation_id, participant_id, opts = {})
  post_conversations_call_participant_monitor_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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

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

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5170

def post_conversations_call_participant_monitor_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_call_participant_monitor ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_call_participant_monitor" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversations_call_participant_monitor" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor".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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

  • (nil) 


5234
5235
5236
5237
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5234

def post_conversations_call_participant_replace(conversation_id, participant_id, body, opts = {})
  post_conversations_call_participant_replace_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5246

def post_conversations_call_participant_replace_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_call_participant_replace ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_call_participant_replace" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversations_call_participant_replace" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_call_participant_replace" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#post_conversations_call_participants(conversation_id, body, opts = {}) ⇒ Conversation

Add participants to a conversation

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:



5317
5318
5319
5320
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5317

def post_conversations_call_participants(conversation_id, body, opts = {})
  data, _status_code, _headers = post_conversations_call_participants_with_http_info(conversation_id, body, opts)
  return data
end

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

Add participants to a conversation

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5328

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Place a new call as part of a callback conversation.

Parameters:

  • conversation_id —

    conversationId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5010

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

  • (nil) 


5393
5394
5395
5396
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5393

def post_conversations_callback_participant_replace(conversation_id, participant_id, body, opts = {})
  post_conversations_callback_participant_replace_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5405

def post_conversations_callback_participant_replace_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_callback_participant_replace ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_callback_participant_replace" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversations_callback_participant_replace" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_callback_participant_replace" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/callbacks/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#post_conversations_callbacks(body, opts = {}) ⇒ CreateCallbackResponse

Create a Callback

Parameters:

  • body —

    Callback

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

    the optional parameters

Returns:



5475
5476
5477
5478
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5475

def post_conversations_callbacks(body, opts = {})
  data, _status_code, _headers = post_conversations_callbacks_with_http_info(body, opts)
  return data
end

#post_conversations_callbacks_with_http_info(body, opts = {}) ⇒ Array<(CreateCallbackResponse, Fixnum, Hash)>

Create a Callback

Parameters:

  • body —

    Callback

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

    the optional parameters

Returns:

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

    CreateCallbackResponse data, response status code and response headers



5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5485

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_conversations_calls(body, opts = {}) ⇒ CreateCallResponse

Create a call conversation

Parameters:

  • body —

    Call request

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

    the optional parameters

Returns:



5540
5541
5542
5543
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5540

def post_conversations_calls(body, opts = {})
  data, _status_code, _headers = post_conversations_calls_with_http_info(body, opts)
  return data
end

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

Create a call conversation

Parameters:

  • body —

    Call request

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

    the optional parameters

Returns:

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

    CreateCallResponse data, response status code and response headers



5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5550

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

  • (nil) 


5607
5608
5609
5610
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5607

def post_conversations_chat_participant_replace(conversation_id, participant_id, body, opts = {})
  post_conversations_chat_participant_replace_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5619

def post_conversations_chat_participant_replace_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_chat_participant_replace ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_chat_participant_replace" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversations_chat_participant_replace" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_chat_participant_replace" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/chats/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#post_conversations_chats(body, opts = {}) ⇒ ChatConversation

Create a web chat conversation

Parameters:

  • body —

    Create web chat request

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

    the optional parameters

Returns:



5689
5690
5691
5692
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5689

def post_conversations_chats(body, opts = {})
  data, _status_code, _headers = post_conversations_chats_with_http_info(body, opts)
  return data
end

#post_conversations_chats_with_http_info(body, opts = {}) ⇒ Array<(ChatConversation, Fixnum, Hash)>

Create a web chat conversation

Parameters:

  • body —

    Create web chat request

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

    the optional parameters

Returns:

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

    ChatConversation data, response status code and response headers



5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5699

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


5756
5757
5758
5759
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5756

def post_conversations_cobrowsesession_participant_replace(conversation_id, participant_id, opts = {})
  post_conversations_cobrowsesession_participant_replace_with_http_info(conversation_id, participant_id, opts)
  return nil
end

#post_conversations_cobrowsesession_participant_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 —

    conversationId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5768

def post_conversations_cobrowsesession_participant_replace_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_cobrowsesession_participant_replace ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_cobrowsesession_participant_replace" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversations_cobrowsesession_participant_replace" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/cobrowsesessions/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#post_conversations_email_inboundmessages(conversation_id, body, opts = {}) ⇒ EmailConversation

Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based.This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.

Parameters:

  • conversation_id —

    conversationId

  • body —

    Send external email reply

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

    the optional parameters

Returns:



5837
5838
5839
5840
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5837

def post_conversations_email_inboundmessages(conversation_id, body, opts = {})
  data, _status_code, _headers = post_conversations_email_inboundmessages_with_http_info(conversation_id, body, opts)
  return data
end

#post_conversations_email_inboundmessages_with_http_info(conversation_id, body, opts = {}) ⇒ Array<(EmailConversation, Fixnum, Hash)>

Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based.This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.

Parameters:

  • conversation_id —

    conversationId

  • body —

    Send external email reply

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

    the optional parameters

Returns:

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

    EmailConversation data, response status code and response headers



5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5848

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_conversations_email_messages(conversation_id, body, opts = {}) ⇒ EmailMessage

Send an email reply

Parameters:

  • conversation_id —

    conversationId

  • body —

    Reply

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

    the optional parameters

Returns:



5912
5913
5914
5915
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5912

def post_conversations_email_messages(conversation_id, body, opts = {})
  data, _status_code, _headers = post_conversations_email_messages_with_http_info(conversation_id, body, opts)
  return data
end

#post_conversations_email_messages_with_http_info(conversation_id, body, opts = {}) ⇒ Array<(EmailMessage, Fixnum, Hash)>

Send an email reply

Parameters:

  • conversation_id —

    conversationId

  • body —

    Reply

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5923

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

  • (nil) 


5988
5989
5990
5991
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 5988

def post_conversations_email_participant_replace(conversation_id, participant_id, body, opts = {})
  post_conversations_email_participant_replace_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 6000

def post_conversations_email_participant_replace_with_http_info(conversation_id, participant_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_email_participant_replace ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_email_participant_replace" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversations_email_participant_replace" if participant_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_email_participant_replace" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/emails/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#post_conversations_emails(body, opts = {}) ⇒ EmailConversation

Create an email conversation

Parameters:

  • body —

    Create email request

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

    the optional parameters

Returns:



6070
6071
6072
6073
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 6070

def post_conversations_emails(body, opts = {})
  data, _status_code, _headers = post_conversations_emails_with_http_info(body, opts)
  return data
end

#post_conversations_emails_with_http_info(body, opts = {}) ⇒ Array<(EmailConversation, Fixnum, Hash)>

Create an email conversation

Parameters:

  • body —

    Create email request

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

    the optional parameters

Returns:

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

    EmailConversation data, response status code and response headers



6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 6080

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_conversations_faxes(body, opts = {}) ⇒ FaxSendResponse

Create Fax Conversation

Parameters:

  • body —

    Fax

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

    the optional parameters

Returns:



6135
6136
6137
6138
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 6135

def post_conversations_faxes(body, opts = {})
  data, _status_code, _headers = post_conversations_faxes_with_http_info(body, opts)
  return data
end

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

Create Fax Conversation

Parameters:

  • body —

    Fax

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

    the optional parameters

Returns:

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

    FaxSendResponse data, response status code and response headers



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 6145

def post_conversations_faxes_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_faxes ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_faxes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/faxes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#put_conversations_call_participant_communication_uuidata(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Set uuiData to be sent on future commands.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    UUIData Request

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

    the optional parameters

Returns:



6203
6204
6205
6206
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 6203

def put_conversations_call_participant_communication_uuidata(conversation_id, participant_id, communication_id, body, opts = {})
  data, _status_code, _headers = put_conversations_call_participant_communication_uuidata_with_http_info(conversation_id, participant_id, communication_id, body, opts)
  return data
end

#put_conversations_call_participant_communication_uuidata_with_http_info(conversation_id, participant_id, communication_id, body, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Set uuiData to be sent on future commands.

Parameters:

  • conversation_id —

    conversationId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    UUIData Request

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

    the optional parameters

Returns:

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

    Empty data, response status code and response headers



6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 6216

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#put_conversations_email_messages_draft(conversation_id, body, opts = {}) ⇒ EmailMessage

Update conversation draft reply

Parameters:

  • conversation_id —

    conversationId

  • body —

    Draft

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

    the optional parameters

Returns:



6296
6297
6298
6299
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 6296

def put_conversations_email_messages_draft(conversation_id, body, opts = {})
  data, _status_code, _headers = put_conversations_email_messages_draft_with_http_info(conversation_id, body, opts)
  return data
end

#put_conversations_email_messages_draft_with_http_info(conversation_id, body, opts = {}) ⇒ Array<(EmailMessage, Fixnum, Hash)>

Update conversation draft reply

Parameters:

  • conversation_id —

    conversationId

  • body —

    Draft

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
 
# File 'lib/purecloudclient_v2a/api/conversations_api.rb', line 6307

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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