Class: PureCloud::ConversationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConversationsApi

Returns a new instance of ConversationsApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Cancel the transfer

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

  • (String) 


33
34
35
36
 
# File 'lib/purecloud/api/conversations_api.rb', line 33

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

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

Cancel the transfer

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/purecloud/api/conversations_api.rb', line 44

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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


99
100
101
102
 
# File 'lib/purecloud/api/conversations_api.rb', line 99

def delete_conversation_id_participants_participant_id_codes_addcommunicationcode(conversation_id, participant_id, add_communication_code, opts = {})
  delete_conversation_id_participants_participant_id_codes_addcommunicationcode_with_http_info(conversation_id, participant_id, add_communication_code, opts)
  return nil
end

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



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

def delete_conversation_id_participants_participant_id_codes_addcommunicationcode_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_id_participants_participant_id_codes_addcommunicationcode ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling delete_conversation_id_participants_participant_id_codes_addcommunicationcode" if conversation_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling delete_conversation_id_participants_participant_id_codes_addcommunicationcode" if participant_id.nil?
  
  # verify the required parameter 'add_communication_code' is set
  fail "Missing the required parameter 'add_communication_code' when calling delete_conversation_id_participants_participant_id_codes_addcommunicationcode" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Delete attachment from draft

Parameters:

  • email_id —

    emailId

  • attachment_id —

    attachmentId

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

    the optional parameters

Returns:

  • (String) 


167
168
169
170
 
# File 'lib/purecloud/api/conversations_api.rb', line 167

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

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

Delete attachment from draft

Parameters:

  • email_id —

    emailId

  • attachment_id —

    attachmentId

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_callbacks(opts = {}) ⇒ CallbackConversationEntityListing

Get callback conversations

Parameters:

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

    the optional parameters

Returns:



230
231
232
233
 
# File 'lib/purecloud/api/conversations_api.rb', line 230

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

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

Get callback conversation

Parameters:

  • callback_id —

    callbackId

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

    the optional parameters

Returns:



286
287
288
289
 
# File 'lib/purecloud/api/conversations_api.rb', line 286

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • callback_id —

    callbackId

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



348
349
350
351
 
# File 'lib/purecloud/api/conversations_api.rb', line 348

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • callback_id —

    callbackId

  • 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



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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/purecloud/api/conversations_api.rb', line 360

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • callback_id —

    callbackId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



415
416
417
418
 
# File 'lib/purecloud/api/conversations_api.rb', line 415

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • callback_id —

    callbackId

  • 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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get callback conversation

Parameters:

  • callback_id —

    callbackId

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

    the optional parameters

Returns:

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

    CallbackConversation data, response status code and response headers



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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/purecloud/api/conversations_api.rb', line 296

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get callback conversations

Parameters:

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

    the optional parameters

Returns:



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/purecloud/api/conversations_api.rb', line 239

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_calls(opts = {}) ⇒ CallConversationEntityListing

Get recent conversations

Parameters:

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

    the optional parameters

Returns:



478
479
480
481
 
# File 'lib/purecloud/api/conversations_api.rb', line 478

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

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

Get call conversation

Parameters:

  • call_id —

    callId

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

    the optional parameters

Returns:



534
535
536
537
 
# File 'lib/purecloud/api/conversations_api.rb', line 534

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • call_id —

    callId

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



596
597
598
599
 
# File 'lib/purecloud/api/conversations_api.rb', line 596

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • call_id —

    callId

  • 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



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/purecloud/api/conversations_api.rb', line 608

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



663
664
665
666
 
# File 'lib/purecloud/api/conversations_api.rb', line 663

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • call_id —

    callId

  • 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



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
707
708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/purecloud/api/conversations_api.rb', line 674

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get call conversation

Parameters:

  • call_id —

    callId

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

    the optional parameters

Returns:

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

    CallConversation data, response status code and response headers



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/purecloud/api/conversations_api.rb', line 544

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_calls_history(opts = {}) ⇒ CallConversationEntityListing

Get call history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

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

Returns:



729
730
731
732
 
# File 'lib/purecloud/api/conversations_api.rb', line 729

def get_calls_history(opts = {})
  data, status_code, headers = get_calls_history_with_http_info(opts)
  return data
end

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

Get call history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :interval (String) —

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

Returns:



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/purecloud/api/conversations_api.rb', line 741

def get_calls_history_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_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']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_calls_maximumconferenceparties(opts = {}) ⇒ MaxParticipants

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

Parameters:

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

    the optional parameters

Returns:



790
791
792
793
 
# File 'lib/purecloud/api/conversations_api.rb', line 790

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    MaxParticipants data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get recent conversations

Parameters:

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

    the optional parameters

Returns:



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_chats(opts = {}) ⇒ ChatConversationEntityListing

Get recent chat conversations

Parameters:

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

    the optional parameters

Returns:



845
846
847
848
 
# File 'lib/purecloud/api/conversations_api.rb', line 845

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

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

Get chat conversation

Parameters:

  • chat_id —

    chatId

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

    the optional parameters

Returns:



901
902
903
904
 
# File 'lib/purecloud/api/conversations_api.rb', line 901

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • chat_id —

    chatId

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



963
964
965
966
 
# File 'lib/purecloud/api/conversations_api.rb', line 963

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • chat_id —

    chatId

  • 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



975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/purecloud/api/conversations_api.rb', line 975

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • chat_id —

    chatId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



1030
1031
1032
1033
 
# File 'lib/purecloud/api/conversations_api.rb', line 1030

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • chat_id —

    chatId

  • 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



1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'lib/purecloud/api/conversations_api.rb', line 1041

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get chat conversation

Parameters:

  • chat_id —

    chatId

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

    the optional parameters

Returns:

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

    ChatConversation data, response status code and response headers



911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/purecloud/api/conversations_api.rb', line 911

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get recent chat conversations

Parameters:

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

    the optional parameters

Returns:



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_cobrowsesessions(opts = {}) ⇒ CobrowseConversationEntityListing

Get recent cobrowse conversations

Parameters:

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

    the optional parameters

Returns:



1093
1094
1095
1096
 
# File 'lib/purecloud/api/conversations_api.rb', line 1093

def get_cobrowsesessions(opts = {})
  data, status_code, headers = get_cobrowsesessions_with_http_info(opts)
  return data
end

#get_cobrowsesessions_cobrowse_id(cobrowse_id, opts = {}) ⇒ CobrowseConversation

Get cobrowse conversation

Parameters:

  • cobrowse_id —

    cobrowseId

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

    the optional parameters

Returns:



1149
1150
1151
1152
 
# File 'lib/purecloud/api/conversations_api.rb', line 1149

def get_cobrowsesessions_cobrowse_id(cobrowse_id, opts = {})
  data, status_code, headers = get_cobrowsesessions_cobrowse_id_with_http_info(cobrowse_id, opts)
  return data
end

#get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup(cobrowse_id, participant_id, opts = {}) ⇒ Wrapup

Get the wrap-up for this conversation participant.

Parameters:

  • cobrowse_id —

    cobrowseId

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



1211
1212
1213
1214
 
# File 'lib/purecloud/api/conversations_api.rb', line 1211

def get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup(cobrowse_id, participant_id, opts = {})
  data, status_code, headers = get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup_with_http_info(cobrowse_id, participant_id, opts)
  return data
end

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

Get the wrap-up for this conversation participant.

Parameters:

  • cobrowse_id —

    cobrowseId

  • 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



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/purecloud/api/conversations_api.rb', line 1223

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes(cobrowse_id, participant_id, opts = {}) ⇒ Array<WrapupCode>

Get list of wrapup codes for this conversation participant

Parameters:

  • cobrowse_id —

    cobrowseId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



1278
1279
1280
1281
 
# File 'lib/purecloud/api/conversations_api.rb', line 1278

def get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes(cobrowse_id, participant_id, opts = {})
  data, status_code, headers = get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes_with_http_info(cobrowse_id, participant_id, opts)
  return data
end

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

Get list of wrapup codes for this conversation participant

Parameters:

  • cobrowse_id —

    cobrowseId

  • 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



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
1329
1330
1331
1332
1333
1334
1335
 
# File 'lib/purecloud/api/conversations_api.rb', line 1289

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_cobrowsesessions_cobrowse_id_with_http_info(cobrowse_id, opts = {}) ⇒ Array<(CobrowseConversation, Fixnum, Hash)>

Get cobrowse conversation

Parameters:

  • cobrowse_id —

    cobrowseId

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

    the optional parameters

Returns:

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

    CobrowseConversation data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get recent cobrowse conversations

Parameters:

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

    the optional parameters

Returns:



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

def get_cobrowsesessions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#get_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Get conversation

Parameters:

  • conversation_id —

    conversation ID

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

    the optional parameters

Returns:



1342
1343
1344
1345
 
# File 'lib/purecloud/api/conversations_api.rb', line 1342

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

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

Returns:



1404
1405
1406
1407
 
# File 'lib/purecloud/api/conversations_api.rb', line 1404

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    WrapupCode data, response status code and response headers



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'lib/purecloud/api/conversations_api.rb', line 1416

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

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

  # form parameters
  form_params = {}

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

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



1471
1472
1473
1474
 
# File 'lib/purecloud/api/conversations_api.rb', line 1471

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

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



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/purecloud/api/conversations_api.rb', line 1482

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

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

  # form parameters
  form_params = {}

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

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

Get conversation

Parameters:

  • conversation_id —

    conversation ID

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



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

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

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

  # form parameters
  form_params = {}

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

#get_conversations(opts = {}) ⇒ ConversationEntityListing

Get conversations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :communication_type (String) —

    Call or Chat communication filtering

Returns:



1535
1536
1537
1538
 
# File 'lib/purecloud/api/conversations_api.rb', line 1535

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

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

Get a conversation by id

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



1593
1594
1595
1596
 
# File 'lib/purecloud/api/conversations_api.rb', line 1593

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

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

Get a conversation by id

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    AnalyticsConversation data, response status code and response headers



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

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

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

  # form parameters
  form_params = {}

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

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

Get conversations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :communication_type (String) —

    Call or Chat communication filtering

Returns:

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

    ConversationEntityListing data, response status code and response headers



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/purecloud/api/conversations_api.rb', line 1545

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

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

  # form parameters
  form_params = {}

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

#get_emails(opts = {}) ⇒ EmailConversationEntityListing

Get recent email conversations

Parameters:

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

    the optional parameters

Returns:



1652
1653
1654
1655
 
# File 'lib/purecloud/api/conversations_api.rb', line 1652

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

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

Get email conversation

Parameters:

  • email_id —

    emailId

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

    the optional parameters

Returns:



1708
1709
1710
1711
 
# File 'lib/purecloud/api/conversations_api.rb', line 1708

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

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

Get conversation messages

Parameters:

  • email_id —

    emailId

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

    the optional parameters

Returns:



1768
1769
1770
1771
 
# File 'lib/purecloud/api/conversations_api.rb', line 1768

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

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

Get conversation draft reply

Parameters:

  • email_id —

    emailId

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

    the optional parameters

Returns:



1828
1829
1830
1831
 
# File 'lib/purecloud/api/conversations_api.rb', line 1828

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

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

Get conversation draft reply

Parameters:

  • email_id —

    emailId

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get conversation message

Parameters:

  • email_id —

    emailId

  • message_id —

    messageId

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

    the optional parameters

Returns:



1889
1890
1891
1892
 
# File 'lib/purecloud/api/conversations_api.rb', line 1889

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

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

Get conversation message

Parameters:

  • email_id —

    emailId

  • message_id —

    messageId

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get conversation messages

Parameters:

  • email_id —

    emailId

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

    the optional parameters

Returns:

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

    EmailMessageListing data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • email_id —

    emailId

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



1955
1956
1957
1958
 
# File 'lib/purecloud/api/conversations_api.rb', line 1955

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • email_id —

    emailId

  • 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



1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/purecloud/api/conversations_api.rb', line 1967

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • email_id —

    emailId

  • participant_id —

    participantId

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

    the optional parameters

Returns:



2022
2023
2024
2025
 
# File 'lib/purecloud/api/conversations_api.rb', line 2022

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • email_id —

    emailId

  • 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



2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
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
 
# File 'lib/purecloud/api/conversations_api.rb', line 2033

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get email conversation

Parameters:

  • email_id —

    emailId

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

    the optional parameters

Returns:

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

    EmailConversation data, response status code and response headers



1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'lib/purecloud/api/conversations_api.rb', line 1718

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get recent email conversations

Parameters:

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

    the optional parameters

Returns:



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_callbacks_callback_id(callback_id, body, opts = {}) ⇒ Conversation

Update a conversation by disconnecting all of the participants

Parameters:

  • callback_id —

    callbackId

  • body —

    Conversation

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

    the optional parameters

Returns:



2087
2088
2089
2090
 
# File 'lib/purecloud/api/conversations_api.rb', line 2087

def patch_callbacks_callback_id(callback_id, body, opts = {})
  data, status_code, headers = patch_callbacks_callback_id_with_http_info(callback_id, body, opts)
  return data
end

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

Update conversation participant

Parameters:

  • callback_id —

    callbackId

  • participant_id —

    participantId

  • body —

    Participant

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

    the optional parameters

Returns:

  • (nil) 


2153
2154
2155
2156
 
# File 'lib/purecloud/api/conversations_api.rb', line 2153

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

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

Update the attributes on a conversation participant.

Parameters:

  • callback_id —

    callbackId

  • participant_id —

    participantId

  • body —

    Attributes

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

    the optional parameters

Returns:

  • (nil) 


2222
2223
2224
2225
 
# File 'lib/purecloud/api/conversations_api.rb', line 2222

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

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

Update the attributes on a conversation participant.

Parameters:

  • callback_id —

    callbackId

  • participant_id —

    participantId

  • body —

    Attributes

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
 
# File 'lib/purecloud/api/conversations_api.rb', line 2234

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_callbacks_callback_id_participants_participant_id_communications_communication_id(callback_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • callback_id —

    callbackId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



2292
2293
2294
2295
 
# File 'lib/purecloud/api/conversations_api.rb', line 2292

def patch_callbacks_callback_id_participants_participant_id_communications_communication_id(callback_id, participant_id, communication_id, body, opts = {})
  data, status_code, headers = patch_callbacks_callback_id_participants_participant_id_communications_communication_id_with_http_info(callback_id, participant_id, communication_id, body, opts)
  return data
end

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

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

Parameters:

  • callback_id —

    callbackId

  • 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



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

def patch_callbacks_callback_id_participants_participant_id_communications_communication_id_with_http_info(callback_id, participant_id, communication_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_callbacks_callback_id_participants_participant_id_communications_communication_id ..."
  end
  
  # verify the required parameter 'callback_id' is set
  fail "Missing the required parameter 'callback_id' when calling patch_callbacks_callback_id_participants_participant_id_communications_communication_id" if callback_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_callbacks_callback_id_participants_participant_id_communications_communication_id" if participant_id.nil?
  
  # verify the required parameter 'communication_id' is set
  fail "Missing the required parameter 'communication_id' when calling patch_callbacks_callback_id_participants_participant_id_communications_communication_id" if communication_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling patch_callbacks_callback_id_participants_participant_id_communications_communication_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/communications/{communicationId}".sub('{format}','json').sub('{' + 'callbackId' + '}', callback_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update conversation participant

Parameters:

  • callback_id —

    callbackId

  • participant_id —

    participantId

  • body —

    Participant

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
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
 
# File 'lib/purecloud/api/conversations_api.rb', line 2165

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update a conversation by disconnecting all of the participants

Parameters:

  • callback_id —

    callbackId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
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
 
# File 'lib/purecloud/api/conversations_api.rb', line 2098

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_calls_call_id(call_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:

  • call_id —

    callId

  • body —

    Conversation

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

    the optional parameters

Returns:



2365
2366
2367
2368
 
# File 'lib/purecloud/api/conversations_api.rb', line 2365

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

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

Update conversation participant

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

  • body —

    Participant request

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

    the optional parameters

Returns:

  • (nil) 


2431
2432
2433
2434
 
# File 'lib/purecloud/api/conversations_api.rb', line 2431

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

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

Update the attributes on a conversation participant.

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

  • body —

    Participant attributes

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

    the optional parameters

Returns:

  • (nil) 


2500
2501
2502
2503
 
# File 'lib/purecloud/api/conversations_api.rb', line 2500

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

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

Update the attributes on a conversation participant.

Parameters:

  • call_id —

    callId

  • 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



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
 
# File 'lib/purecloud/api/conversations_api.rb', line 2512

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_calls_call_id_participants_participant_id_communications_communication_id(call_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



2570
2571
2572
2573
 
# File 'lib/purecloud/api/conversations_api.rb', line 2570

def patch_calls_call_id_participants_participant_id_communications_communication_id(call_id, participant_id, communication_id, body, opts = {})
  data, status_code, headers = patch_calls_call_id_participants_participant_id_communications_communication_id_with_http_info(call_id, participant_id, communication_id, body, opts)
  return data
end

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

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

Parameters:

  • call_id —

    callId

  • 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



2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
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
 
# File 'lib/purecloud/api/conversations_api.rb', line 2583

def patch_calls_call_id_participants_participant_id_communications_communication_id_with_http_info(call_id, participant_id, communication_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_calls_call_id_participants_participant_id_communications_communication_id ..."
  end
  
  # verify the required parameter 'call_id' is set
  fail "Missing the required parameter 'call_id' when calling patch_calls_call_id_participants_participant_id_communications_communication_id" if call_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_calls_call_id_participants_participant_id_communications_communication_id" if participant_id.nil?
  
  # verify the required parameter 'communication_id' is set
  fail "Missing the required parameter 'communication_id' when calling patch_calls_call_id_participants_participant_id_communications_communication_id" if communication_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling patch_calls_call_id_participants_participant_id_communications_communication_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/calls/{callId}/participants/{participantId}/communications/{communicationId}".sub('{format}','json').sub('{' + 'callId' + '}', call_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Change who can speak

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

  • body —

    new speak to

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

    the optional parameters

Returns:



2644
2645
2646
2647
 
# File 'lib/purecloud/api/conversations_api.rb', line 2644

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

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

Change who can speak

Parameters:

  • call_id —

    callId

  • 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



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
 
# File 'lib/purecloud/api/conversations_api.rb', line 2656

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update conversation participant

Parameters:

  • call_id —

    callId

  • 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



2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
 
# File 'lib/purecloud/api/conversations_api.rb', line 2443

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_calls_call_id_with_http_info(call_id, 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:

  • call_id —

    callId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
 
# File 'lib/purecloud/api/conversations_api.rb', line 2376

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_chats_chat_id(chat_id, body, opts = {}) ⇒ Conversation

Update a conversation by disconnecting all of the participants

Parameters:

  • chat_id —

    chatId

  • body —

    Conversation

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

    the optional parameters

Returns:



2713
2714
2715
2716
 
# File 'lib/purecloud/api/conversations_api.rb', line 2713

def patch_chats_chat_id(chat_id, body, opts = {})
  data, status_code, headers = patch_chats_chat_id_with_http_info(chat_id, body, opts)
  return data
end

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

Update conversation participant

Parameters:

  • chat_id —

    chatId

  • participant_id —

    participantId

  • body —

    Update request

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

    the optional parameters

Returns:

  • (nil) 


2779
2780
2781
2782
 
# File 'lib/purecloud/api/conversations_api.rb', line 2779

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

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

Update the attributes on a conversation participant.

Parameters:

  • chat_id —

    chatId

  • participant_id —

    participantId

  • body —

    Participant attributes

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

    the optional parameters

Returns:

  • (nil) 


2848
2849
2850
2851
 
# File 'lib/purecloud/api/conversations_api.rb', line 2848

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

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

Update the attributes on a conversation participant.

Parameters:

  • chat_id —

    chatId

  • 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



2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
 
# File 'lib/purecloud/api/conversations_api.rb', line 2860

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_chats_chat_id_participants_participant_id_communications_communication_id(chat_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • chat_id —

    chatId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



2918
2919
2920
2921
 
# File 'lib/purecloud/api/conversations_api.rb', line 2918

def patch_chats_chat_id_participants_participant_id_communications_communication_id(chat_id, participant_id, communication_id, body, opts = {})
  data, status_code, headers = patch_chats_chat_id_participants_participant_id_communications_communication_id_with_http_info(chat_id, participant_id, communication_id, body, opts)
  return data
end

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

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

Parameters:

  • chat_id —

    chatId

  • 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



2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
 
# File 'lib/purecloud/api/conversations_api.rb', line 2931

def patch_chats_chat_id_participants_participant_id_communications_communication_id_with_http_info(chat_id, participant_id, communication_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_chats_chat_id_participants_participant_id_communications_communication_id ..."
  end
  
  # verify the required parameter 'chat_id' is set
  fail "Missing the required parameter 'chat_id' when calling patch_chats_chat_id_participants_participant_id_communications_communication_id" if chat_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_chats_chat_id_participants_participant_id_communications_communication_id" if participant_id.nil?
  
  # verify the required parameter 'communication_id' is set
  fail "Missing the required parameter 'communication_id' when calling patch_chats_chat_id_participants_participant_id_communications_communication_id" if communication_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling patch_chats_chat_id_participants_participant_id_communications_communication_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/chats/{chatId}/participants/{participantId}/communications/{communicationId}".sub('{format}','json').sub('{' + 'chatId' + '}', chat_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update conversation participant

Parameters:

  • chat_id —

    chatId

  • 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



2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
 
# File 'lib/purecloud/api/conversations_api.rb', line 2791

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update a conversation by disconnecting all of the participants

Parameters:

  • chat_id —

    chatId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
 
# File 'lib/purecloud/api/conversations_api.rb', line 2724

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_cobrowsesessions_cobrowse_id(cobrowse_id, body, opts = {}) ⇒ Conversation

Update a conversation by disconnecting all of the participants

Parameters:

  • cobrowse_id —

    cobrowseId

  • body —

    Conversation

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

    the optional parameters

Returns:



2991
2992
2993
2994
 
# File 'lib/purecloud/api/conversations_api.rb', line 2991

def patch_cobrowsesessions_cobrowse_id(cobrowse_id, body, opts = {})
  data, status_code, headers = patch_cobrowsesessions_cobrowse_id_with_http_info(cobrowse_id, body, opts)
  return data
end

#patch_cobrowsesessions_cobrowse_id_participants_participant_id(cobrowse_id, participant_id, opts = {}) ⇒ nil

Update conversation participant

Parameters:

  • cobrowse_id —

    cobrowseId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3057
3058
3059
3060
 
# File 'lib/purecloud/api/conversations_api.rb', line 3057

def patch_cobrowsesessions_cobrowse_id_participants_participant_id(cobrowse_id, participant_id, opts = {})
  patch_cobrowsesessions_cobrowse_id_participants_participant_id_with_http_info(cobrowse_id, participant_id, opts)
  return nil
end

#patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes(cobrowse_id, participant_id, opts = {}) ⇒ nil

Update the attributes on a conversation participant.

Parameters:

  • cobrowse_id —

    cobrowseId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3123
3124
3125
3126
 
# File 'lib/purecloud/api/conversations_api.rb', line 3123

def patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes(cobrowse_id, participant_id, opts = {})
  patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes_with_http_info(cobrowse_id, participant_id, opts)
  return nil
end

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

Update the attributes on a conversation participant.

Parameters:

  • cobrowse_id —

    cobrowseId

  • 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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id(cobrowse_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • cobrowse_id —

    cobrowseId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



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

def patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id(cobrowse_id, participant_id, communication_id, body, opts = {})
  data, status_code, headers = patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id_with_http_info(cobrowse_id, participant_id, communication_id, body, opts)
  return data
end

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

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

Parameters:

  • cobrowse_id —

    cobrowseId

  • 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



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

def patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id_with_http_info(cobrowse_id, participant_id, communication_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id ..."
  end
  
  # verify the required parameter 'cobrowse_id' is set
  fail "Missing the required parameter 'cobrowse_id' when calling patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id" if cobrowse_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id" if participant_id.nil?
  
  # verify the required parameter 'communication_id' is set
  fail "Missing the required parameter 'communication_id' when calling patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id" if communication_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/communications/{communicationId}".sub('{format}','json').sub('{' + 'cobrowseId' + '}', cobrowse_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update conversation participant

Parameters:

  • cobrowse_id —

    cobrowseId

  • 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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update a conversation by disconnecting all of the participants

Parameters:

  • cobrowse_id —

    cobrowseId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



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
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
 
# File 'lib/purecloud/api/conversations_api.rb', line 3002

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_conversation_id_participants_participant_id(conversation_id, participant_id, 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) 


3264
3265
3266
3267
 
# File 'lib/purecloud/api/conversations_api.rb', line 3264

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

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


3333
3334
3335
3336
 
# File 'lib/purecloud/api/conversations_api.rb', line 3333

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

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



3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
 
# File 'lib/purecloud/api/conversations_api.rb', line 3345

def patch_conversation_id_participants_participant_id_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_id_participants_participant_id_attributes ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling patch_conversation_id_participants_participant_id_attributes" if conversation_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_conversation_id_participants_participant_id_attributes" if participant_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling patch_conversation_id_participants_participant_id_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversation_id_participants_participant_id_with_http_info(conversation_id, participant_id, 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



3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
 
# File 'lib/purecloud/api/conversations_api.rb', line 3276

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

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

  # form parameters
  form_params = {}

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

#patch_emails_email_id(email_id, body, opts = {}) ⇒ Conversation

Update a conversation by disconnecting all of the participants

Parameters:

  • email_id —

    emailId

  • body —

    Conversation

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

    the optional parameters

Returns:



3401
3402
3403
3404
 
# File 'lib/purecloud/api/conversations_api.rb', line 3401

def patch_emails_email_id(email_id, body, opts = {})
  data, status_code, headers = patch_emails_email_id_with_http_info(email_id, body, opts)
  return data
end

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

Update conversation participant

Parameters:

  • email_id —

    emailId

  • participant_id —

    participantId

  • body —

    Update request

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

    the optional parameters

Returns:

  • (nil) 


3467
3468
3469
3470
 
# File 'lib/purecloud/api/conversations_api.rb', line 3467

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

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

Update the attributes on a conversation participant.

Parameters:

  • email_id —

    emailId

  • participant_id —

    participantId

  • body —

    Participant attributes

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

    the optional parameters

Returns:

  • (nil) 


3536
3537
3538
3539
 
# File 'lib/purecloud/api/conversations_api.rb', line 3536

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

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

Update the attributes on a conversation participant.

Parameters:

  • email_id —

    emailId

  • 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



3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
 
# File 'lib/purecloud/api/conversations_api.rb', line 3548

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_emails_email_id_participants_participant_id_communications_communication_id(email_id, participant_id, communication_id, body, opts = {}) ⇒ Empty

Update conversation participant’s communication by disconnecting it.

Parameters:

  • email_id —

    emailId

  • participant_id —

    participantId

  • communication_id —

    communicationId

  • body —

    Participant

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

    the optional parameters

Returns:



3606
3607
3608
3609
 
# File 'lib/purecloud/api/conversations_api.rb', line 3606

def patch_emails_email_id_participants_participant_id_communications_communication_id(email_id, participant_id, communication_id, body, opts = {})
  data, status_code, headers = patch_emails_email_id_participants_participant_id_communications_communication_id_with_http_info(email_id, participant_id, communication_id, body, opts)
  return data
end

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

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

Parameters:

  • email_id —

    emailId

  • 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



3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
 
# File 'lib/purecloud/api/conversations_api.rb', line 3619

def patch_emails_email_id_participants_participant_id_communications_communication_id_with_http_info(email_id, participant_id, communication_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#patch_emails_email_id_participants_participant_id_communications_communication_id ..."
  end
  
  # verify the required parameter 'email_id' is set
  fail "Missing the required parameter 'email_id' when calling patch_emails_email_id_participants_participant_id_communications_communication_id" if email_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling patch_emails_email_id_participants_participant_id_communications_communication_id" if participant_id.nil?
  
  # verify the required parameter 'communication_id' is set
  fail "Missing the required parameter 'communication_id' when calling patch_emails_email_id_participants_participant_id_communications_communication_id" if communication_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling patch_emails_email_id_participants_participant_id_communications_communication_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/conversations/emails/{emailId}/participants/{participantId}/communications/{communicationId}".sub('{format}','json').sub('{' + 'emailId' + '}', email_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update conversation participant

Parameters:

  • email_id —

    emailId

  • 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



3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
 
# File 'lib/purecloud/api/conversations_api.rb', line 3479

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update a conversation by disconnecting all of the participants

Parameters:

  • email_id —

    emailId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_callbacks(body, opts = {}) ⇒ CreateCallbackResponse

Create a Callback

Parameters:

  • body —

    Callback

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

    the optional parameters

Returns:



3678
3679
3680
3681
 
# File 'lib/purecloud/api/conversations_api.rb', line 3678

def post_callbacks(body, opts = {})
  data, status_code, headers = post_callbacks_with_http_info(body, opts)
  return data
end

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

Replace this participant with the specified user and/or address

Parameters:

  • callback_id —

    callbackId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

  • (nil) 


3740
3741
3742
3743
 
# File 'lib/purecloud/api/conversations_api.rb', line 3740

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

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

Replace this participant with the specified user and/or address

Parameters:

  • callback_id —

    callbackId

  • 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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
 
# File 'lib/purecloud/api/conversations_api.rb', line 3688

def post_callbacks_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_callbacks ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#post_calls(body, opts = {}) ⇒ CreateCallResponse

Create a call conversation

Parameters:

  • body —

    Call request

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

    the optional parameters

Returns:



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

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

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

Add a new call to a conversation

Parameters:

  • call_id —

    callId

  • body —

    Conversation

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

    the optional parameters

Returns:



3868
3869
3870
3871
 
# File 'lib/purecloud/api/conversations_api.rb', line 3868

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

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

Add participants to a conversation

Parameters:

  • call_id —

    callId

  • body —

    Conversation

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

    the optional parameters

Returns:



3933
3934
3935
3936
 
# File 'lib/purecloud/api/conversations_api.rb', line 3933

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

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

Initiate and update consult transfer

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

  • body —

    Destination address &amp; initial speak to

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

    the optional parameters

Returns:



3999
4000
4001
4002
 
# File 'lib/purecloud/api/conversations_api.rb', line 3999

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

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

Initiate and update consult transfer

Parameters:

  • call_id —

    callId

  • 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



4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
 
# File 'lib/purecloud/api/conversations_api.rb', line 4011

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

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

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

  • (nil) 


4068
4069
4070
4071
 
# File 'lib/purecloud/api/conversations_api.rb', line 4068

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

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

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

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Replace this participant with the specified user and/or address

Parameters:

  • call_id —

    callId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

  • (nil) 


4133
4134
4135
4136
 
# File 'lib/purecloud/api/conversations_api.rb', line 4133

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

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

Replace this participant with the specified user and/or address

Parameters:

  • call_id —

    callId

  • 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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Add participants to a conversation

Parameters:

  • call_id —

    callId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
 
# File 'lib/purecloud/api/conversations_api.rb', line 3944

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Add a new call to a conversation

Parameters:

  • call_id —

    callId

  • body —

    Conversation

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
 
# File 'lib/purecloud/api/conversations_api.rb', line 3879

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
 
# File 'lib/purecloud/api/conversations_api.rb', line 3817

def post_calls_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_calls ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#post_chats(body, opts = {}) ⇒ ChatConversation

Create a web chat conversation

Parameters:

  • body —

    Create web chat request

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

    the optional parameters

Returns:



4200
4201
4202
4203
 
# File 'lib/purecloud/api/conversations_api.rb', line 4200

def post_chats(body, opts = {})
  data, status_code, headers = post_chats_with_http_info(body, opts)
  return data
end

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

Replace this participant with the specified user and/or address

Parameters:

  • chat_id —

    chatId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

  • (nil) 


4262
4263
4264
4265
 
# File 'lib/purecloud/api/conversations_api.rb', line 4262

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

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

Replace this participant with the specified user and/or address

Parameters:

  • chat_id —

    chatId

  • 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



4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
 
# File 'lib/purecloud/api/conversations_api.rb', line 4274

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
 
# File 'lib/purecloud/api/conversations_api.rb', line 4210

def post_chats_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_chats ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#post_cobrowsesessions_cobrowse_id_participants_participant_id_replace(cobrowse_id, participant_id, opts = {}) ⇒ nil

Replace this participant with the specified user and/or address

Parameters:

  • cobrowse_id —

    cobrowseId

  • participant_id —

    participantId

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


4331
4332
4333
4334
 
# File 'lib/purecloud/api/conversations_api.rb', line 4331

def post_cobrowsesessions_cobrowse_id_participants_participant_id_replace(cobrowse_id, participant_id, opts = {})
  post_cobrowsesessions_cobrowse_id_participants_participant_id_replace_with_http_info(cobrowse_id, participant_id, opts)
  return nil
end

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

Replace this participant with the specified user and/or address

Parameters:

  • cobrowse_id —

    cobrowseId

  • 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



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
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'lib/purecloud/api/conversations_api.rb', line 4343

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

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

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


4397
4398
4399
4400
 
# File 'lib/purecloud/api/conversations_api.rb', line 4397

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

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

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

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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

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

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

  # form parameters
  form_params = {}

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

#post_conversation_id_participants_participant_id_replace(conversation_id, participant_id, 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) 


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

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

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



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

def post_conversation_id_participants_participant_id_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_id_participants_participant_id_replace ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling post_conversation_id_participants_participant_id_replace" if conversation_id.nil?
  
  # verify the required parameter 'participant_id' is set
  fail "Missing the required parameter 'participant_id' when calling post_conversation_id_participants_participant_id_replace" if participant_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_conversation_id_participants_participant_id_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Query for conversation aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



4530
4531
4532
4533
 
# File 'lib/purecloud/api/conversations_api.rb', line 4530

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

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



4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
 
# File 'lib/purecloud/api/conversations_api.rb', line 4540

def post_conversations_aggregates_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_conversations_aggregates_query ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Index conversation properties

Parameters:

  • conversation_id —

    conversationId

  • body —

    request

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

    the optional parameters

Returns:



4591
4592
4593
4594
 
# File 'lib/purecloud/api/conversations_api.rb', line 4591

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

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



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
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
 
# File 'lib/purecloud/api/conversations_api.rb', line 4602

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

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

  # form parameters
  form_params = {}

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

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

Query for conversation details

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



4655
4656
4657
4658
 
# File 'lib/purecloud/api/conversations_api.rb', line 4655

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

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



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

def post_conversations_details_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_conversations_details_query ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#post_emails(body, opts = {}) ⇒ EmailConversation

Create an email conversation

Parameters:

  • body —

    Create email request

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

    the optional parameters

Returns:



4715
4716
4717
4718
 
# File 'lib/purecloud/api/conversations_api.rb', line 4715

def post_emails(body, opts = {})
  data, status_code, headers = post_emails_with_http_info(body, opts)
  return data
end

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

Send an email reply

Parameters:

  • email_id —

    emailId

  • body —

    Reply

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

    the optional parameters

Returns:



4776
4777
4778
4779
 
# File 'lib/purecloud/api/conversations_api.rb', line 4776

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

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

Send an email reply

Parameters:

  • email_id —

    emailId

  • body —

    Reply

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
 
# File 'lib/purecloud/api/conversations_api.rb', line 4787

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Replace this participant with the specified user and/or address

Parameters:

  • email_id —

    emailId

  • participant_id —

    participantId

  • body —

    Transfer request

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

    the optional parameters

Returns:

  • (nil) 


4842
4843
4844
4845
 
# File 'lib/purecloud/api/conversations_api.rb', line 4842

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

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

Replace this participant with the specified user and/or address

Parameters:

  • email_id —

    emailId

  • 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



4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
 
# File 'lib/purecloud/api/conversations_api.rb', line 4854

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_emails_with_http_info(body, opts = {}) ⇒ Array<(EmailConversation, Fixnum, Hash)>

Create an email conversation

Parameters:

  • body —

    Create email request

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

    the optional parameters

Returns:

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

    EmailConversation data, response status code and response headers



4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
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
 
# File 'lib/purecloud/api/conversations_api.rb', line 4725

def post_emails_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_emails ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

#post_faxes(body, opts = {}) ⇒ FaxSendResponse

Create Fax Conversation

Parameters:

  • body —

    Fax

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

    the optional parameters

Returns:



4909
4910
4911
4912
 
# File 'lib/purecloud/api/conversations_api.rb', line 4909

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

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



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

def post_faxes_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConversationsApi#post_faxes ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

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

Update conversation draft reply

Parameters:

  • email_id —

    emailId

  • body —

    Draft

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

    the optional parameters

Returns:



4970
4971
4972
4973
 
# File 'lib/purecloud/api/conversations_api.rb', line 4970

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

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

Update conversation draft reply

Parameters:

  • email_id —

    emailId

  • body —

    Draft

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

    the optional parameters

Returns:

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

    EmailMessage data, response status code and response headers



4981
4982
4983
4984
4985
4986
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
 
# File 'lib/purecloud/api/conversations_api.rb', line 4981

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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