Class: PureCloud::ConversationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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 active conversations for the logged in user

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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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 active callback conversations for the logged in user

Parameters:

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

    the optional parameters

Returns:



1224
1225
1226
1227
 
# File 'lib/purecloudplatformclientv2/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 active callback conversations for the logged in user

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/purecloudplatformclientv2/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 active call conversations for the logged in user

Parameters:

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

    the optional parameters

Returns:



1279
1280
1281
1282
 
# File 'lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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 active call conversations for the logged in user

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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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 active chat conversations for the logged in user

Parameters:

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

    the optional parameters

Returns:



1704
1705
1706
1707
 
# File 'lib/purecloudplatformclientv2/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 active chat conversations for the logged in user

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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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 active cobrowse conversations for the logged in user

Parameters:

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

    the optional parameters

Returns:



1983
1984
1985
1986
 
# File 'lib/purecloudplatformclientv2/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 active cobrowse conversations for the logged in user

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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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 active email conversations for the logged in user

Parameters:

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

    the optional parameters

Returns:



2467
2468
2469
2470
 
# File 'lib/purecloudplatformclientv2/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 active email conversations for the logged in user

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/purecloudplatformclientv2/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_message(conversation_id, opts = {}) ⇒ MessageConversation

Get message conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



2523
2524
2525
2526
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2523

def get_conversations_message(conversation_id, opts = {})
  data, _status_code, _headers = get_conversations_message_with_http_info(conversation_id, opts)
  return data
end

#get_conversations_message_message(conversation_id, message_id, opts = {}) ⇒ MessageData

Get message

Parameters:

  • conversation_id —

    conversationId

  • message_id —

    messageId

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

    the optional parameters

Returns:



2589
2590
2591
2592
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2589

def get_conversations_message_message(conversation_id, message_id, opts = {})
  data, _status_code, _headers = get_conversations_message_message_with_http_info(conversation_id, message_id, opts)
  return data
end

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

Get message

Parameters:

  • conversation_id —

    conversationId

  • message_id —

    messageId

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

    the optional parameters

Returns:

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

    MessageData data, response status code and response headers



2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2600

def get_conversations_message_message_with_http_info(conversation_id, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_message_message ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_message_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_message_message" if message_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{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 => 'MessageData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversations_message_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



2665
2666
2667
2668
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2665

def get_conversations_message_participant_wrapup(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_message_participant_wrapup_with_http_info(conversation_id, participant_id, opts)
  return data
end

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



2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2677

def get_conversations_message_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_message_participant_wrapup ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_message_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_message_participant_wrapup" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{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_message_participant_wrapup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



2748
2749
2750
2751
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2748

def get_conversations_message_participant_wrapupcodes(conversation_id, participant_id, opts = {})
  data, _status_code, _headers = get_conversations_message_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts)
  return data
end

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



2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2759

def get_conversations_message_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_message_participant_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_message_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_message_participant_wrapupcodes" if participant_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{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_message_participant_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversations_message_with_http_info(conversation_id, opts = {}) ⇒ Array<(MessageConversation, Fixnum, Hash)>

Get message conversation

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    MessageConversation data, response status code and response headers



2533
2534
2535
2536
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2533

def get_conversations_message_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_message ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_message" if conversation_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{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 => 'MessageConversation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversations_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_conversations_messages(opts = {}) ⇒ MessageConversationEntityListing

Get active message conversations for the logged in user

Parameters:

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

    the optional parameters

Returns:



2821
2822
2823
2824
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2821

def get_conversations_messages(opts = {})
  data, _status_code, _headers = get_conversations_messages_with_http_info(opts)
  return data
end

#get_conversations_messages_with_http_info(opts = {}) ⇒ Array<(MessageConversationEntityListing, Fixnum, Hash)>

Get active message conversations for the logged in user

Parameters:

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

    the optional parameters

Returns:



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

def get_conversations_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_messages ..."
  end
  
  # resource path
  local_var_path = "/api/v2/conversations/messages".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 => 'MessageConversationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#get_conversations_messages\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 active conversations for the logged in user

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/purecloudplatformclientv2/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) 


2879
2880
2881
2882
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2879

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) 


2963
2964
2965
2966
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2963

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



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
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2975

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



2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2891

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:



3046
3047
3048
3049
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3046

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) 


3122
3123
3124
3125
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3122

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) 


3206
3207
3208
3209
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3206

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



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
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3218

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:



3291
3292
3293
3294
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3291

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



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
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3304

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:



3385
3386
3387
3388
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3385

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



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
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3397

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



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
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3134

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



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
3108
3109
3110
3111
3112
3113
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3057

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:



3469
3470
3471
3472
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3469

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) 


3545
3546
3547
3548
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3545

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) 


3629
3630
3631
3632
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3629

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



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
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3641

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:



3714
3715
3716
3717
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3714

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



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
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3727

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



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
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3557

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



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
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3480

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:



3807
3808
3809
3810
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3807

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) 


3883
3884
3885
3886
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3883

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) 


3967
3968
3969
3970
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3967

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



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
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3979

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:



4052
4053
4054
4055
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4052

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



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
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4065

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



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
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3895

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



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
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3818

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:



4145
4146
4147
4148
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4145

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) 


4221
4222
4223
4224
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4221

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) 


4303
4304
4305
4306
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4303

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



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
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4315

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:



4386
4387
4388
4389
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4386

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



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
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4399

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



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
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4233

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



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
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4156

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:



4479
4480
4481
4482
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4479

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) 


4555
4556
4557
4558
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4555

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) 


4639
4640
4641
4642
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4639

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



4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4651

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:



4724
4725
4726
4727
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4724

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



4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4737

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



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
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4567

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



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
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4490

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

#patch_conversations_message(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:



4817
4818
4819
4820
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4817

def patch_conversations_message(conversation_id, body, opts = {})
  data, _status_code, _headers = patch_conversations_message_with_http_info(conversation_id, body, opts)
  return data
end

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


4893
4894
4895
4896
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4893

def patch_conversations_message_participant(conversation_id, participant_id, opts = {})
  patch_conversations_message_participant_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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


4975
4976
4977
4978
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4975

def patch_conversations_message_participant_attributes(conversation_id, participant_id, opts = {})
  patch_conversations_message_participant_attributes_with_http_info(conversation_id, participant_id, opts)
  return nil
end

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



4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4987

def patch_conversations_message_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_message_participant_attributes ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_message_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_message_participant_attributes" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{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_message_participant_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



5058
5059
5060
5061
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5058

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

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



5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5071

def patch_conversations_message_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_message_participant_communication ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_message_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_message_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_message_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_message_participant_communication" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{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_message_participant_communication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4905

def patch_conversations_message_participant_with_http_info(conversation_id, participant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_message_participant ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_message_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_message_participant" if participant_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{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_message_participant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4828

def patch_conversations_message_with_http_info(conversation_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.patch_conversations_message ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.patch_conversations_message" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_message" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{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_message\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:



5151
5152
5153
5154
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5151

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



5162
5163
5164
5165
5166
5167
5168
5169
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5162

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:



5225
5226
5227
5228
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5225

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



5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5235

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:



5290
5291
5292
5293
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5290

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:



5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5300

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_disconnect(conversation_id, opts = {}) ⇒ String

Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.

Parameters:

  • conversation_id —

    conversation ID

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

    the optional parameters

Returns:

  • (String) 


5355
5356
5357
5358
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5355

def post_conversation_disconnect(conversation_id, opts = {})
  data, _status_code, _headers = post_conversation_disconnect_with_http_info(conversation_id, opts)
  return data
end

#post_conversation_disconnect_with_http_info(conversation_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.

Parameters:

  • conversation_id —

    conversation ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5365

def post_conversation_disconnect_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversation_disconnect ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversation_disconnect" if conversation_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/{conversationId}/disconnect".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(: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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_conversation_disconnect\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) 


5422
5423
5424
5425
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5422

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



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
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5434

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) 


5504
5505
5506
5507
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5504

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



5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5516

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) 


5586
5587
5588
5589
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5586

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



5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5598

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:



5670
5671
5672
5673
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5670

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



5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5682

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:



5752
5753
5754
5755
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5752

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:



5828
5829
5830
5831
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5828

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



5840
5841
5842
5843
5844
5845
5846
5847
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/purecloudplatformclientv2/api/conversations_api.rb', line 5840

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) 


5912
5913
5914
5915
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5912

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



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

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) 


5987
5988
5989
5990
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5987

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



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

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:



6070
6071
6072
6073
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6070

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



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
6129
6130
6131
6132
6133
6134
6135
6136
6137
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6081

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



5763
5764
5765
5766
5767
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 5763

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) 


6146
6147
6148
6149
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6146

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



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
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6158

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:



6228
6229
6230
6231
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6228

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



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

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:



6293
6294
6295
6296
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6293

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



6303
6304
6305
6306
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6303

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) 


6360
6361
6362
6363
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6360

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



6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6372

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:



6442
6443
6444
6445
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6442

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



6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6452

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) 


6509
6510
6511
6512
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6509

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



6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6521

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:



6590
6591
6592
6593
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6590

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



6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6601

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:



6665
6666
6667
6668
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6665

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



6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6676

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) 


6741
6742
6743
6744
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6741

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



6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6753

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 If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.

Parameters:

  • body —

    Create email request

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

    the optional parameters

Returns:



6823
6824
6825
6826
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6823

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 If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.

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



6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6833

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:



6888
6889
6890
6891
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6888

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



6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6898

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

#post_conversations_message_communication_messages(conversation_id, communication_id, body, opts = {}) ⇒ MessageData

Send message

Parameters:

  • conversation_id —

    conversationId

  • communication_id —

    communicationId

  • body —

    Message

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

    the optional parameters

Returns:



6955
6956
6957
6958
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6955

def post_conversations_message_communication_messages(conversation_id, communication_id, body, opts = {})
  data, _status_code, _headers = post_conversations_message_communication_messages_with_http_info(conversation_id, communication_id, body, opts)
  return data
end

#post_conversations_message_communication_messages_with_http_info(conversation_id, communication_id, body, opts = {}) ⇒ Array<(MessageData, Fixnum, Hash)>

Send message

Parameters:

  • conversation_id —

    conversationId

  • communication_id —

    communicationId

  • body —

    Message

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

    the optional parameters

Returns:

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

    MessageData data, response status code and response headers



6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 6967

def post_conversations_message_communication_messages_with_http_info(conversation_id, communication_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_message_communication_messages ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_message_communication_messages" if conversation_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'communication_id' is set
  fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.post_conversations_message_communication_messages" if communication_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_message_communication_messages" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_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(: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 => 'MessageData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_message_communication_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversations_message_messages_bulk(conversation_id, opts = {}) ⇒ TextMessageListing

Get messages in batch

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    messageIds

Returns:



7039
7040
7041
7042
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 7039

def post_conversations_message_messages_bulk(conversation_id, opts = {})
  data, _status_code, _headers = post_conversations_message_messages_bulk_with_http_info(conversation_id, opts)
  return data
end

#post_conversations_message_messages_bulk_with_http_info(conversation_id, opts = {}) ⇒ Array<(TextMessageListing, Fixnum, Hash)>

Get messages in batch

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    messageIds

Returns:

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

    TextMessageListing data, response status code and response headers



7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 7050

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(: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 => 'TextMessageListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_message_messages_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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


7113
7114
7115
7116
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 7113

def post_conversations_message_participant_replace(conversation_id, participant_id, body, opts = {})
  post_conversations_message_participant_replace_with_http_info(conversation_id, participant_id, body, opts)
  return nil
end

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



7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 7125

def post_conversations_message_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_message_participant_replace ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_message_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_message_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_message_participant_replace" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/conversations/messages/{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_message_participant_replace\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:



7198
7199
7200
7201
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 7198

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



7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 7211

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:



7291
7292
7293
7294
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 7291

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



7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 7302

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