Class: PureCloud::ConversationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConversationsApi

Returns a new instance of ConversationsApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete a code used to add a communication to this participant

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • add_communication_code —

    addCommunicationCode

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

    the optional parameters

Returns:

  • (nil) 


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

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

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

Delete a code used to add a communication to this participant

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • add_communication_code —

    addCommunicationCode

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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


97
98
99
100
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 97

def delete_conversations_call_participant_consult(call_id, participant_id, opts = {})
  data, _status_code, _headers = delete_conversations_call_participant_consult_with_http_info(call_id, participant_id, opts)
  return data
end

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 108

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

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

  # form parameters
  form_params = {}

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

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


158
159
160
161
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 158

def delete_conversations_email_messages_draft_attachment(email_id, attachment_id, opts = {})
  data, _status_code, _headers = delete_conversations_email_messages_draft_attachment_with_http_info(email_id, attachment_id, opts)
  return data
end

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



169
170
171
172
173
174
175
176
177
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 169

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

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

  # form parameters
  form_params = {}

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

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

Get a conversation by id

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:



218
219
220
221
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 218

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

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

Get a conversation by id

Parameters:

  • conversation_id —

    conversationId

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

    the optional parameters

Returns:

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

    AnalyticsConversation data, response status code and response headers



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 228

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get conversation

Parameters:

  • conversation_id —

    conversation ID

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

    the optional parameters

Returns:



275
276
277
278
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 275

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

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

Returns:



334
335
336
337
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 334

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

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

Get the wrap-up for this conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

  • :provisional (BOOLEAN) —

    Indicates if the wrap-up code is provisional.

Returns:

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

    WrapupCode data, response status code and response headers



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

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Returns:



397
398
399
400
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 397

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

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

Get list of wrapup codes for this conversation participant

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Returns:

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

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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 408

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get conversation

Parameters:

  • conversation_id —

    conversation ID

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

    the optional parameters

Returns:

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

    Conversation data, response status code and response headers



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 285

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations(opts = {}) ⇒ ConversationEntityListing

Get conversations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :communication_type (String) —

    Call or Chat communication filtering

Returns:



457
458
459
460
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 457

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

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

Get call conversation

Parameters:

  • call_id —

    callId

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

    the optional parameters

Returns:



513
514
515
516
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 513

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

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



572
573
574
575
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 572

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

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



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

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

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

  # form parameters
  form_params = {}

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

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



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

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

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



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 646

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

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

  # form parameters
  form_params = {}

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

#get_conversations_call_with_http_info(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



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 523

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

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

  # form parameters
  form_params = {}

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

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

Get callback conversation

Parameters:

  • callback_id —

    callbackId

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

    the optional parameters

Returns:



695
696
697
698
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 695

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

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



754
755
756
757
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 754

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

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



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 766

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

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

  # form parameters
  form_params = {}

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

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



817
818
819
820
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 817

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

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



828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 828

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

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

  # form parameters
  form_params = {}

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

#get_conversations_callback_with_http_info(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



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 705

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

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

  # form parameters
  form_params = {}

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

#get_conversations_callbacks(opts = {}) ⇒ CallbackConversationEntityListing

Get callback conversations

Parameters:

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

    the optional parameters

Returns:



876
877
878
879
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 876

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

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

Get callback conversations

Parameters:

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

    the optional parameters

Returns:



885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 885

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_calls(opts = {}) ⇒ CallConversationEntityListing

Get recent conversations

Parameters:

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

    the optional parameters

Returns:



929
930
931
932
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 929

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

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



985
986
987
988
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 985

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

#get_conversations_calls_history_with_http_info(opts = {}) ⇒ Array<(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:



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
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 997

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

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'interval'] = opts[:'interval'] if opts[:'interval']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_conversations_calls_maximumconferenceparties(opts = {}) ⇒ MaxParticipants

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

Parameters:

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

    the optional parameters

Returns:



1044
1045
1046
1047
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1044

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

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

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

Parameters:

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

    the optional parameters

Returns:

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

    MaxParticipants data, response status code and response headers



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
1088
1089
1090
1091
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1053

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get recent conversations

Parameters:

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

    the optional parameters

Returns:



938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 938

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get chat conversation

Parameters:

  • chat_id —

    chatId

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

    the optional parameters

Returns:



1098
1099
1100
1101
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1098

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

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



1157
1158
1159
1160
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1157

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

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



1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1169

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

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

  # form parameters
  form_params = {}

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

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



1220
1221
1222
1223
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1220

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

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



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

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

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

  # form parameters
  form_params = {}

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

#get_conversations_chat_with_http_info(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



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1108

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

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

  # form parameters
  form_params = {}

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

#get_conversations_chats(opts = {}) ⇒ ChatConversationEntityListing

Get recent chat conversations

Parameters:

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

    the optional parameters

Returns:



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

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

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

Get recent chat conversations

Parameters:

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

    the optional parameters

Returns:



1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1288

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get cobrowse conversation

Parameters:

  • cobrowse_id —

    cobrowseId

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

    the optional parameters

Returns:



1333
1334
1335
1336
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1333

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

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



1392
1393
1394
1395
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1392

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

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



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

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

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

  # form parameters
  form_params = {}

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

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



1455
1456
1457
1458
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1455

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

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



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1466

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

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

  # form parameters
  form_params = {}

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

#get_conversations_cobrowsesession_with_http_info(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



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1343

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

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

  # form parameters
  form_params = {}

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

#get_conversations_cobrowsesessions(opts = {}) ⇒ CobrowseConversationEntityListing

Get recent cobrowse conversations

Parameters:

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

    the optional parameters

Returns:



1514
1515
1516
1517
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1514

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

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

Get recent cobrowse conversations

Parameters:

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

    the optional parameters

Returns:



1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1523

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get email conversation

Parameters:

  • email_id —

    emailId

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

    the optional parameters

Returns:



1568
1569
1570
1571
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1568

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

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

Get conversation message

Parameters:

  • email_id —

    emailId

  • message_id —

    messageId

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

    the optional parameters

Returns:



1626
1627
1628
1629
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1626

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

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



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

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

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

  # form parameters
  form_params = {}

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

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

Get conversation messages

Parameters:

  • email_id —

    emailId

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

    the optional parameters

Returns:



1686
1687
1688
1689
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1686

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

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

Get conversation draft reply

Parameters:

  • email_id —

    emailId

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

    the optional parameters

Returns:



1743
1744
1745
1746
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1743

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

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



1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1753

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

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

  # form parameters
  form_params = {}

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

#get_conversations_email_messages_with_http_info(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



1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1696

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

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

  # form parameters
  form_params = {}

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

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



1802
1803
1804
1805
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1802

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

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



1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1814

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

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

  # form parameters
  form_params = {}

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

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



1865
1866
1867
1868
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1865

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

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



1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1876

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

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

  # form parameters
  form_params = {}

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

#get_conversations_email_with_http_info(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



1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1578

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

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

  # form parameters
  form_params = {}

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

#get_conversations_emails(opts = {}) ⇒ EmailConversationEntityListing

Get recent email conversations

Parameters:

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

    the optional parameters

Returns:



1924
1925
1926
1927
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1924

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

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

Get recent email conversations

Parameters:

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

    the optional parameters

Returns:



1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1933

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Get conversations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :communication_type (String) —

    Call or Chat communication filtering

Returns:

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

    ConversationEntityListing data, response status code and response headers



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 467

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update a participant. Update conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Update request

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

    the optional parameters

Returns:

  • (nil) 


1980
1981
1982
1983
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1980

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

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Participant attributes

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

    the optional parameters

Returns:

  • (nil) 


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

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

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

Update the attributes on a conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Participant attributes

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2056

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update a participant. Update conversation participant.

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Update request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 1992

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



2107
2108
2109
2110
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2107

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

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


2169
2170
2171
2172
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2169

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

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


2233
2234
2235
2236
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2233

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

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



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
2283
2284
2285
2286
2287
2288
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2245

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

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

  # form parameters
  form_params = {}

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

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



2298
2299
2300
2301
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2298

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

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



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

def patch_conversations_call_participant_communication_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_conversations_call_participant_communication ..."
  end
  # verify the required parameter 'call_id' is set
  fail ArgumentError, "Missing the required parameter 'call_id' when calling ConversationsApi.patch_conversations_call_participant_communication" if call_id.nil?
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_call_participant_communication" if participant_id.nil?
  # verify the required parameter 'communication_id' is set
  fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.patch_conversations_call_participant_communication" if communication_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_call_participant_communication" if body.nil?
  # resource path
  local_var_path = "/api/v2/conversations/calls/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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



2366
2367
2368
2369
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2366

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

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



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

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

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

  # form parameters
  form_params = {}

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

#patch_conversations_call_participant_with_http_info(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



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
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2181

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

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

  # form parameters
  form_params = {}

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

#patch_conversations_call_with_http_info(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



2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2118

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



2430
2431
2432
2433
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2430

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

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


2492
2493
2494
2495
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2492

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

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


2556
2557
2558
2559
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2556

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

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



2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2568

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

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

  # form parameters
  form_params = {}

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

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



2621
2622
2623
2624
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2621

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

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



2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2634

def patch_conversations_callback_participant_communication_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_conversations_callback_participant_communication ..."
  end
  # verify the required parameter 'callback_id' is set
  fail ArgumentError, "Missing the required parameter 'callback_id' when calling ConversationsApi.patch_conversations_callback_participant_communication" if callback_id.nil?
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_callback_participant_communication" if participant_id.nil?
  # verify the required parameter 'communication_id' is set
  fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.patch_conversations_callback_participant_communication" if communication_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_callback_participant_communication" if body.nil?
  # resource path
  local_var_path = "/api/v2/conversations/callbacks/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_callback_participant_with_http_info(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



2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2504

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

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

  # form parameters
  form_params = {}

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

#patch_conversations_callback_with_http_info(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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



2688
2689
2690
2691
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2688

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

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


2750
2751
2752
2753
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2750

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

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


2814
2815
2816
2817
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2814

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

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



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

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

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

  # form parameters
  form_params = {}

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

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



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

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

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



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

def patch_conversations_chat_participant_communication_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_conversations_chat_participant_communication ..."
  end
  # verify the required parameter 'chat_id' is set
  fail ArgumentError, "Missing the required parameter 'chat_id' when calling ConversationsApi.patch_conversations_chat_participant_communication" if chat_id.nil?
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_chat_participant_communication" if participant_id.nil?
  # verify the required parameter 'communication_id' is set
  fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.patch_conversations_chat_participant_communication" if communication_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_chat_participant_communication" if body.nil?
  # resource path
  local_var_path = "/api/v2/conversations/chats/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_chat_participant_with_http_info(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



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

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

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

  # form parameters
  form_params = {}

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

#patch_conversations_chat_with_http_info(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



2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2699

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



2946
2947
2948
2949
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 2946

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

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


3008
3009
3010
3011
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3008

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

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


3070
3071
3072
3073
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3070

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

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



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
3115
3116
3117
3118
3119
3120
3121
3122
3123
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3082

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

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

  # form parameters
  form_params = {}

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

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



3133
3134
3135
3136
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3133

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

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



3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3146

def patch_conversations_cobrowsesession_participant_communication_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_conversations_cobrowsesession_participant_communication ..."
  end
  # verify the required parameter 'cobrowse_id' is set
  fail ArgumentError, "Missing the required parameter 'cobrowse_id' when calling ConversationsApi.patch_conversations_cobrowsesession_participant_communication" if cobrowse_id.nil?
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_cobrowsesession_participant_communication" if participant_id.nil?
  # verify the required parameter 'communication_id' is set
  fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.patch_conversations_cobrowsesession_participant_communication" if communication_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_cobrowsesession_participant_communication" if body.nil?
  # resource path
  local_var_path = "/api/v2/conversations/cobrowsesessions/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_cobrowsesession_participant_with_http_info(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



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
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3020

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

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

  # form parameters
  form_params = {}

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

#patch_conversations_cobrowsesession_with_http_info(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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



3200
3201
3202
3203
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3200

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

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


3262
3263
3264
3265
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3262

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

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


3326
3327
3328
3329
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3326

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

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



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

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

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

  # form parameters
  form_params = {}

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

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



3391
3392
3393
3394
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3391

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

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



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

def patch_conversations_email_participant_communication_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_conversations_email_participant_communication ..."
  end
  # verify the required parameter 'email_id' is set
  fail ArgumentError, "Missing the required parameter 'email_id' when calling ConversationsApi.patch_conversations_email_participant_communication" if email_id.nil?
  # verify the required parameter 'participant_id' is set
  fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.patch_conversations_email_participant_communication" if participant_id.nil?
  # verify the required parameter 'communication_id' is set
  fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.patch_conversations_email_participant_communication" if communication_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.patch_conversations_email_participant_communication" if body.nil?
  # resource path
  local_var_path = "/api/v2/conversations/emails/{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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#patch_conversations_email_participant_with_http_info(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



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

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

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

  # form parameters
  form_params = {}

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

#patch_conversations_email_with_http_info(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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Index conversation properties

Parameters:

  • conversation_id —

    conversationId

  • body —

    request

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

    the optional parameters

Returns:



3458
3459
3460
3461
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3458

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

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

Index conversation properties

Parameters:

  • conversation_id —

    conversationId

  • body —

    request

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

    the optional parameters

Returns:

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

    PropertyIndexRequest data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Query for conversation aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



3518
3519
3520
3521
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3518

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

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

Query for conversation aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:

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

    AggregateQueryResponse data, response status code and response headers



3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3528

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Query for conversation details

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



3575
3576
3577
3578
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3575

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

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

Query for conversation details

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3585

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

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

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


3634
3635
3636
3637
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3634

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

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

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

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3646

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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


3696
3697
3698
3699
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3696

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

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

Replace this participant with the specified user and/or address

Parameters:

  • conversation_id —

    conversation ID

  • participant_id —

    participant ID

  • body —

    Transfer request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3708

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



3759
3760
3761
3762
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3759

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

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



3821
3822
3823
3824
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3821

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

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



3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3833

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

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

  # form parameters
  form_params = {}

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

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


3885
3886
3887
3888
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3885

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

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



3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3896

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

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

  # form parameters
  form_params = {}

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

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


3946
3947
3948
3949
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3946

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

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



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
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3958

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

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

  # form parameters
  form_params = {}

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

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

Add participants to a conversation

Parameters:

  • call_id —

    callId

  • body —

    Conversation

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

    the optional parameters

Returns:



4009
4010
4011
4012
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4009

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

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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_conversations_call_with_http_info(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



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
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 3770

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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


4071
4072
4073
4074
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4071

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

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



4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4083

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

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

  # form parameters
  form_params = {}

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

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

Create a Callback

Parameters:

  • body —

    Callback

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

    the optional parameters

Returns:



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

def post_conversations_callbacks(body, opts = {})
  data, _status_code, _headers = post_conversations_callbacks_with_http_info(body, opts)
  return data
end

#post_conversations_callbacks_with_http_info(body, opts = {}) ⇒ Array<(CreateCallbackResponse, Fixnum, Hash)>

Create a Callback

Parameters:

  • body —

    Callback

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

    the optional parameters

Returns:

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

    CreateCallbackResponse data, response status code and response headers



4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4143

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Create a call conversation

Parameters:

  • body —

    Call request

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

    the optional parameters

Returns:



4190
4191
4192
4193
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4190

def post_conversations_calls(body, opts = {})
  data, _status_code, _headers = post_conversations_calls_with_http_info(body, opts)
  return data
end

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

Create a call conversation

Parameters:

  • body —

    Call request

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

    the optional parameters

Returns:

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

    CreateCallResponse data, response status code and response headers



4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
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
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4200

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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


4249
4250
4251
4252
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4249

def post_conversations_chat_participant_replace(chat_id, participant_id, body, opts = {})
  post_conversations_chat_participant_replace_with_http_info(chat_id, participant_id, body, opts)
  return nil
end

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



4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4261

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

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

  # form parameters
  form_params = {}

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

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

Create a web chat conversation

Parameters:

  • body —

    Create web chat request

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

    the optional parameters

Returns:



4311
4312
4313
4314
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4311

def post_conversations_chats(body, opts = {})
  data, _status_code, _headers = post_conversations_chats_with_http_info(body, opts)
  return data
end

#post_conversations_chats_with_http_info(body, opts = {}) ⇒ Array<(ChatConversation, Fixnum, Hash)>

Create a web chat conversation

Parameters:

  • body —

    Create web chat request

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

    the optional parameters

Returns:

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

    ChatConversation data, response status code and response headers



4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4321

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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


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

def post_conversations_cobrowsesession_participant_replace(cobrowse_id, participant_id, opts = {})
  post_conversations_cobrowsesession_participant_replace_with_http_info(cobrowse_id, participant_id, opts)
  return nil
end

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



4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4382

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

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

  # form parameters
  form_params = {}

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

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

Send an email reply

Parameters:

  • email_id —

    emailId

  • body —

    Reply

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

    the optional parameters

Returns:



4431
4432
4433
4434
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4431

def post_conversations_email_messages(email_id, body, opts = {})
  data, _status_code, _headers = post_conversations_email_messages_with_http_info(email_id, body, opts)
  return data
end

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



4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4442

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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


4493
4494
4495
4496
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4493

def post_conversations_email_participant_replace(email_id, participant_id, body, opts = {})
  post_conversations_email_participant_replace_with_http_info(email_id, participant_id, body, opts)
  return nil
end

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



4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4505

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

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

  # form parameters
  form_params = {}

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

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

Create an email conversation

Parameters:

  • body —

    Create email request

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

    the optional parameters

Returns:



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

def post_conversations_emails(body, opts = {})
  data, _status_code, _headers = post_conversations_emails_with_http_info(body, opts)
  return data
end

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

Create an email conversation

Parameters:

  • body —

    Create email request

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

    the optional parameters

Returns:

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

    EmailConversation data, response status code and response headers



4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4565

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Create Fax Conversation

Parameters:

  • body —

    Fax

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

    the optional parameters

Returns:



4612
4613
4614
4615
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4612

def post_conversations_faxes(body, opts = {})
  data, _status_code, _headers = post_conversations_faxes_with_http_info(body, opts)
  return data
end

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

Create Fax Conversation

Parameters:

  • body —

    Fax

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

    the optional parameters

Returns:

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

    FaxSendResponse data, response status code and response headers



4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4622

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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



4670
4671
4672
4673
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4670

def put_conversations_email_messages_draft(email_id, body, opts = {})
  data, _status_code, _headers = put_conversations_email_messages_draft_with_http_info(email_id, body, opts)
  return data
end

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



4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
 
# File 'lib/purecloudplatformclientv2/api/conversations_api.rb', line 4681

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

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

  # form parameters
  form_params = {}

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