ultracart_api 3.10.184 → 3.10.186

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +84 -4
  3. data/docs/ConversationApi.md +2466 -340
  4. data/docs/ConversationPbxAgent.md +16 -0
  5. data/docs/ConversationPbxAgentResponse.md +12 -0
  6. data/docs/ConversationPbxAgentsResponse.md +12 -0
  7. data/docs/ConversationPbxAudio.md +16 -0
  8. data/docs/ConversationPbxAudioResponse.md +12 -0
  9. data/docs/ConversationPbxAudiosResponse.md +12 -0
  10. data/docs/ConversationPbxCustomerSnapshotRequest.md +15 -0
  11. data/docs/ConversationPbxCustomerSnapshotResponse.md +14 -0
  12. data/docs/ConversationPbxMenu.md +17 -0
  13. data/docs/ConversationPbxMenuMapping.md +11 -0
  14. data/docs/ConversationPbxMenuResponse.md +12 -0
  15. data/docs/ConversationPbxMenusResponse.md +12 -0
  16. data/docs/ConversationPbxPhoneNumber.md +12 -0
  17. data/docs/ConversationPbxPhoneNumberResponse.md +12 -0
  18. data/docs/ConversationPbxPhoneNumbersResponse.md +12 -0
  19. data/docs/ConversationPbxQueue.md +27 -0
  20. data/docs/ConversationPbxQueueMembers.md +9 -0
  21. data/docs/ConversationPbxQueueResponse.md +12 -0
  22. data/docs/ConversationPbxQueuesResponse.md +12 -0
  23. data/docs/ConversationPbxTimeBased.md +11 -0
  24. data/docs/ConversationPbxTimeBasedMapping.md +11 -0
  25. data/docs/ConversationPbxTimeBasedMappingConfig.md +9 -0
  26. data/docs/ConversationPbxTimeBasedResponse.md +12 -0
  27. data/docs/ConversationPbxTimeBasedsResponse.md +12 -0
  28. data/docs/ConversationPbxTimeRange.md +12 -0
  29. data/docs/ConversationPbxTimeRangeConfig.md +13 -0
  30. data/docs/ConversationPbxTimeRangeResponse.md +12 -0
  31. data/docs/ConversationPbxTimeRangesResponse.md +12 -0
  32. data/docs/ConversationPbxVoicemailMailbox.md +18 -0
  33. data/docs/ConversationPbxVoicemailMailboxResponse.md +12 -0
  34. data/docs/ConversationPbxVoicemailMailboxesResponse.md +12 -0
  35. data/docs/WorkflowAgentAuth.md +10 -0
  36. data/docs/WorkflowAgentAuthResponse.md +12 -0
  37. data/docs/WorkflowApi.md +92 -0
  38. data/docs/WorkflowTaskTagsResponse.md +12 -0
  39. data/lib/ultracart_api/api/conversation_api.rb +2919 -609
  40. data/lib/ultracart_api/api/workflow_api.rb +98 -0
  41. data/lib/ultracart_api/models/conversation_pbx_agent.rb +325 -0
  42. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +221 -0
  43. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +223 -0
  44. data/lib/ultracart_api/models/conversation_pbx_audio.rb +355 -0
  45. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +221 -0
  46. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +223 -0
  47. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +248 -0
  48. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +243 -0
  49. data/lib/ultracart_api/models/conversation_pbx_menu.rb +367 -0
  50. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +215 -0
  51. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +221 -0
  52. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +223 -0
  53. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +300 -0
  54. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +221 -0
  55. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +223 -0
  56. data/lib/ultracart_api/models/conversation_pbx_queue.rb +524 -0
  57. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +197 -0
  58. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +221 -0
  59. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +223 -0
  60. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +211 -0
  61. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +275 -0
  62. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +196 -0
  63. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +221 -0
  64. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +223 -0
  65. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +287 -0
  66. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +235 -0
  67. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +221 -0
  68. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +223 -0
  69. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +405 -0
  70. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +221 -0
  71. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +223 -0
  72. data/lib/ultracart_api/models/workflow_agent_auth.rb +202 -0
  73. data/lib/ultracart_api/models/workflow_agent_auth_response.rb +221 -0
  74. data/lib/ultracart_api/models/workflow_task_tags_response.rb +224 -0
  75. data/lib/ultracart_api/version.rb +1 -1
  76. data/lib/ultracart_api.rb +34 -0
  77. metadata +70 -2
@@ -7,6 +7,14 @@ Method | HTTP request | Description
7
7
  [**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
8
8
  [**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
9
9
  [**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
10
+ [**delete_pbx_agent**](ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent
11
+ [**delete_pbx_audio**](ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
12
+ [**delete_pbx_menu**](ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
13
+ [**delete_pbx_phone_number**](ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
14
+ [**delete_pbx_queue**](ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
15
+ [**delete_pbx_time_based**](ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
16
+ [**delete_pbx_time_range**](ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
17
+ [**delete_pbx_voicemail_mailbox**](ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
10
18
  [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
11
19
  [**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
12
20
  [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
@@ -19,15 +27,41 @@ Method | HTTP request | Description
19
27
  [**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
20
28
  [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
21
29
  [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
30
+ [**get_conversation_pbx_audio_upload_url**](ConversationApi.md#get_conversation_pbx_audio_upload_url) | **GET** /conversation/pbx/audio/upload_url/{extension} | Get a pre-signed conversation multimedia upload URL
31
+ [**get_conversation_pbx_customer_snapshot**](ConversationApi.md#get_conversation_pbx_customer_snapshot) | **POST** /conversation/pbx/customer_snapshot | Get orders and customer information for a phone number
22
32
  [**get_conversation_permissions**](ConversationApi.md#get_conversation_permissions) | **GET** /conversation/permissions | Retrieve conversation permissions
23
33
  [**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
24
34
  [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
25
35
  [**get_conversations_autocomplete**](ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field
26
36
  [**get_conversations_search**](ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
27
37
  [**get_locations_for_engagement**](ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
38
+ [**get_pbx_agent**](ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
39
+ [**get_pbx_agents**](ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
40
+ [**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
41
+ [**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
42
+ [**get_pbx_menu**](ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
43
+ [**get_pbx_menus**](ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
44
+ [**get_pbx_phone_number**](ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
45
+ [**get_pbx_phone_numbers**](ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
46
+ [**get_pbx_queue**](ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
47
+ [**get_pbx_queues**](ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues
48
+ [**get_pbx_time_based**](ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased
49
+ [**get_pbx_time_baseds**](ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
50
+ [**get_pbx_time_range**](ConversationApi.md#get_pbx_time_range) | **GET** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Get pbx timeRange
51
+ [**get_pbx_time_ranges**](ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
52
+ [**get_pbx_voicemail_mailbox**](ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
53
+ [**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
28
54
  [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
29
55
  [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
30
56
  [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
57
+ [**insert_pbx_agent**](ConversationApi.md#insert_pbx_agent) | **POST** /conversation/pbx/agent | Insert pbx agent
58
+ [**insert_pbx_audio**](ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
59
+ [**insert_pbx_menu**](ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
60
+ [**insert_pbx_phone_number**](ConversationApi.md#insert_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Insert pbx phoneNumber
61
+ [**insert_pbx_queue**](ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
62
+ [**insert_pbx_time_based**](ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
63
+ [**insert_pbx_time_range**](ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange
64
+ [**insert_pbx_voicemail_mailbox**](ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
31
65
  [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
32
66
  [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
33
67
  [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
@@ -39,6 +73,14 @@ Method | HTTP request | Description
39
73
  [**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
40
74
  [**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
41
75
  [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
76
+ [**update_pbx_agent**](ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
77
+ [**update_pbx_audio**](ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
78
+ [**update_pbx_menu**](ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
79
+ [**update_pbx_phone_number**](ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
80
+ [**update_pbx_queue**](ConversationApi.md#update_pbx_queue) | **PUT** /conversation/pbx/queue/{conversationPbxQueueUuid} | Update pbx queue
81
+ [**update_pbx_time_based**](ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased
82
+ [**update_pbx_time_range**](ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
83
+ [**update_pbx_voicemail_mailbox**](ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
42
84
 
43
85
 
44
86
  # **delete_conversation_canned_message**
@@ -188,12 +230,1809 @@ nil (empty response body)
188
230
 
189
231
 
190
232
 
233
+ # **delete_pbx_agent**
234
+ > ConversationPbxAgentResponse delete_pbx_agent(conversation_pbx_agent_uuid)
235
+
236
+ Delete pbx agent
237
+
238
+ Delete a pbx agent
239
+
240
+ ### Example
241
+ ```ruby
242
+ # load the gem
243
+ require 'ultracart_api'
244
+
245
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
246
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
247
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
248
+
249
+
250
+ conversation_pbx_agent_uuid = 'conversation_pbx_agent_uuid_example' # String |
251
+
252
+
253
+ begin
254
+ #Delete pbx agent
255
+ result = api_instance.delete_pbx_agent(conversation_pbx_agent_uuid)
256
+ p result
257
+ rescue UltracartClient::ApiError => e
258
+ puts "Exception when calling ConversationApi->delete_pbx_agent: #{e}"
259
+ end
260
+ ```
261
+
262
+ ### Parameters
263
+
264
+ Name | Type | Description | Notes
265
+ ------------- | ------------- | ------------- | -------------
266
+ **conversation_pbx_agent_uuid** | **String**| |
267
+
268
+ ### Return type
269
+
270
+ [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
271
+
272
+ ### Authorization
273
+
274
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
275
+
276
+ ### HTTP request headers
277
+
278
+ - **Content-Type**: application/json
279
+ - **Accept**: application/json
280
+
281
+
282
+
283
+ # **delete_pbx_audio**
284
+ > ConversationPbxAudioResponse delete_pbx_audio(conversation_pbx_audio_uuid)
285
+
286
+ Delete pbx audio
287
+
288
+ Delete a pbx audio
289
+
290
+ ### Example
291
+ ```ruby
292
+ # load the gem
293
+ require 'ultracart_api'
294
+
295
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
296
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
297
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
298
+
299
+
300
+ conversation_pbx_audio_uuid = 'conversation_pbx_audio_uuid_example' # String |
301
+
302
+
303
+ begin
304
+ #Delete pbx audio
305
+ result = api_instance.delete_pbx_audio(conversation_pbx_audio_uuid)
306
+ p result
307
+ rescue UltracartClient::ApiError => e
308
+ puts "Exception when calling ConversationApi->delete_pbx_audio: #{e}"
309
+ end
310
+ ```
311
+
312
+ ### Parameters
313
+
314
+ Name | Type | Description | Notes
315
+ ------------- | ------------- | ------------- | -------------
316
+ **conversation_pbx_audio_uuid** | **String**| |
317
+
318
+ ### Return type
319
+
320
+ [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
321
+
322
+ ### Authorization
323
+
324
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
325
+
326
+ ### HTTP request headers
327
+
328
+ - **Content-Type**: application/json
329
+ - **Accept**: application/json
330
+
331
+
332
+
333
+ # **delete_pbx_menu**
334
+ > ConversationPbxMenuResponse delete_pbx_menu(conversation_pbx_menu_uuid)
335
+
336
+ Delete pbx menu
337
+
338
+ Delete a pbx menu
339
+
340
+ ### Example
341
+ ```ruby
342
+ # load the gem
343
+ require 'ultracart_api'
344
+
345
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
346
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
347
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
348
+
349
+
350
+ conversation_pbx_menu_uuid = 'conversation_pbx_menu_uuid_example' # String |
351
+
352
+
353
+ begin
354
+ #Delete pbx menu
355
+ result = api_instance.delete_pbx_menu(conversation_pbx_menu_uuid)
356
+ p result
357
+ rescue UltracartClient::ApiError => e
358
+ puts "Exception when calling ConversationApi->delete_pbx_menu: #{e}"
359
+ end
360
+ ```
361
+
362
+ ### Parameters
363
+
364
+ Name | Type | Description | Notes
365
+ ------------- | ------------- | ------------- | -------------
366
+ **conversation_pbx_menu_uuid** | **String**| |
367
+
368
+ ### Return type
369
+
370
+ [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
371
+
372
+ ### Authorization
373
+
374
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
375
+
376
+ ### HTTP request headers
377
+
378
+ - **Content-Type**: application/json
379
+ - **Accept**: application/json
380
+
381
+
382
+
383
+ # **delete_pbx_phone_number**
384
+ > ConversationPbxPhoneNumberResponse delete_pbx_phone_number(conversation_pbx_phone_number_uuid)
385
+
386
+ Delete pbx phoneNumber
387
+
388
+ Delete a pbx phoneNumber
389
+
390
+ ### Example
391
+ ```ruby
392
+ # load the gem
393
+ require 'ultracart_api'
394
+
395
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
396
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
397
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
398
+
399
+
400
+ conversation_pbx_phone_number_uuid = 'conversation_pbx_phone_number_uuid_example' # String |
401
+
402
+
403
+ begin
404
+ #Delete pbx phoneNumber
405
+ result = api_instance.delete_pbx_phone_number(conversation_pbx_phone_number_uuid)
406
+ p result
407
+ rescue UltracartClient::ApiError => e
408
+ puts "Exception when calling ConversationApi->delete_pbx_phone_number: #{e}"
409
+ end
410
+ ```
411
+
412
+ ### Parameters
413
+
414
+ Name | Type | Description | Notes
415
+ ------------- | ------------- | ------------- | -------------
416
+ **conversation_pbx_phone_number_uuid** | **String**| |
417
+
418
+ ### Return type
419
+
420
+ [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
421
+
422
+ ### Authorization
423
+
424
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
425
+
426
+ ### HTTP request headers
427
+
428
+ - **Content-Type**: application/json
429
+ - **Accept**: application/json
430
+
431
+
432
+
433
+ # **delete_pbx_queue**
434
+ > ConversationPbxQueueResponse delete_pbx_queue(conversation_pbx_queue_uuid)
435
+
436
+ Delete pbx queue
437
+
438
+ Delete a pbx queue
439
+
440
+ ### Example
441
+ ```ruby
442
+ # load the gem
443
+ require 'ultracart_api'
444
+
445
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
446
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
447
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
448
+
449
+
450
+ conversation_pbx_queue_uuid = 'conversation_pbx_queue_uuid_example' # String |
451
+
452
+
453
+ begin
454
+ #Delete pbx queue
455
+ result = api_instance.delete_pbx_queue(conversation_pbx_queue_uuid)
456
+ p result
457
+ rescue UltracartClient::ApiError => e
458
+ puts "Exception when calling ConversationApi->delete_pbx_queue: #{e}"
459
+ end
460
+ ```
461
+
462
+ ### Parameters
463
+
464
+ Name | Type | Description | Notes
465
+ ------------- | ------------- | ------------- | -------------
466
+ **conversation_pbx_queue_uuid** | **String**| |
467
+
468
+ ### Return type
469
+
470
+ [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
471
+
472
+ ### Authorization
473
+
474
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
475
+
476
+ ### HTTP request headers
477
+
478
+ - **Content-Type**: application/json
479
+ - **Accept**: application/json
480
+
481
+
482
+
483
+ # **delete_pbx_time_based**
484
+ > ConversationPbxTimeBasedResponse delete_pbx_time_based(conversation_pbx_time_based_uuid)
485
+
486
+ Delete pbx timeBased
487
+
488
+ Delete a pbx timeBased
489
+
490
+ ### Example
491
+ ```ruby
492
+ # load the gem
493
+ require 'ultracart_api'
494
+
495
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
496
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
497
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
498
+
499
+
500
+ conversation_pbx_time_based_uuid = 'conversation_pbx_time_based_uuid_example' # String |
501
+
502
+
503
+ begin
504
+ #Delete pbx timeBased
505
+ result = api_instance.delete_pbx_time_based(conversation_pbx_time_based_uuid)
506
+ p result
507
+ rescue UltracartClient::ApiError => e
508
+ puts "Exception when calling ConversationApi->delete_pbx_time_based: #{e}"
509
+ end
510
+ ```
511
+
512
+ ### Parameters
513
+
514
+ Name | Type | Description | Notes
515
+ ------------- | ------------- | ------------- | -------------
516
+ **conversation_pbx_time_based_uuid** | **String**| |
517
+
518
+ ### Return type
519
+
520
+ [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
521
+
522
+ ### Authorization
523
+
524
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
525
+
526
+ ### HTTP request headers
527
+
528
+ - **Content-Type**: application/json
529
+ - **Accept**: application/json
530
+
531
+
532
+
533
+ # **delete_pbx_time_range**
534
+ > ConversationPbxTimeRangeResponse delete_pbx_time_range(conversation_pbx_time_range_uuid)
535
+
536
+ Delete pbx timeRange
537
+
538
+ Delete a pbx timeRange
539
+
540
+ ### Example
541
+ ```ruby
542
+ # load the gem
543
+ require 'ultracart_api'
544
+
545
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
546
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
547
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
548
+
549
+
550
+ conversation_pbx_time_range_uuid = 'conversation_pbx_time_range_uuid_example' # String |
551
+
552
+
553
+ begin
554
+ #Delete pbx timeRange
555
+ result = api_instance.delete_pbx_time_range(conversation_pbx_time_range_uuid)
556
+ p result
557
+ rescue UltracartClient::ApiError => e
558
+ puts "Exception when calling ConversationApi->delete_pbx_time_range: #{e}"
559
+ end
560
+ ```
561
+
562
+ ### Parameters
563
+
564
+ Name | Type | Description | Notes
565
+ ------------- | ------------- | ------------- | -------------
566
+ **conversation_pbx_time_range_uuid** | **String**| |
567
+
568
+ ### Return type
569
+
570
+ [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
571
+
572
+ ### Authorization
573
+
574
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
575
+
576
+ ### HTTP request headers
577
+
578
+ - **Content-Type**: application/json
579
+ - **Accept**: application/json
580
+
581
+
582
+
583
+ # **delete_pbx_voicemail_mailbox**
584
+ > ConversationPbxVoicemailMailboxResponse delete_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
585
+
586
+ Delete pbx voicemailMailbox
587
+
588
+ Delete a pbx voicemailMailbox
589
+
590
+ ### Example
591
+ ```ruby
592
+ # load the gem
593
+ require 'ultracart_api'
594
+
595
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
596
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
597
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
598
+
599
+
600
+ conversation_pbx_voicemail_mailbox_uuid = 'conversation_pbx_voicemail_mailbox_uuid_example' # String |
601
+
602
+
603
+ begin
604
+ #Delete pbx voicemailMailbox
605
+ result = api_instance.delete_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
606
+ p result
607
+ rescue UltracartClient::ApiError => e
608
+ puts "Exception when calling ConversationApi->delete_pbx_voicemail_mailbox: #{e}"
609
+ end
610
+ ```
611
+
612
+ ### Parameters
613
+
614
+ Name | Type | Description | Notes
615
+ ------------- | ------------- | ------------- | -------------
616
+ **conversation_pbx_voicemail_mailbox_uuid** | **String**| |
617
+
618
+ ### Return type
619
+
620
+ [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
621
+
622
+ ### Authorization
623
+
624
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
625
+
626
+ ### HTTP request headers
627
+
628
+ - **Content-Type**: application/json
629
+ - **Accept**: application/json
630
+
631
+
632
+
191
633
  # **get_agent_keep_alive**
192
634
  > get_agent_keep_alive
193
635
 
194
- Agent keep alive
636
+ Agent keep alive
637
+
638
+ Called periodically by the conversation API to keep the session alive.
639
+
640
+ ### Example
641
+ ```ruby
642
+ # load the gem
643
+ require 'ultracart_api'
644
+
645
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
646
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
647
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
648
+
649
+
650
+
651
+ begin
652
+ #Agent keep alive
653
+ api_instance.get_agent_keep_alive
654
+ rescue UltracartClient::ApiError => e
655
+ puts "Exception when calling ConversationApi->get_agent_keep_alive: #{e}"
656
+ end
657
+ ```
658
+
659
+ ### Parameters
660
+ This endpoint does not need any parameter.
661
+
662
+ ### Return type
663
+
664
+ nil (empty response body)
665
+
666
+ ### Authorization
667
+
668
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
669
+
670
+ ### HTTP request headers
671
+
672
+ - **Content-Type**: application/json
673
+ - **Accept**: application/json
674
+
675
+
676
+
677
+ # **get_agent_profile**
678
+ > ConversationAgentProfileResponse get_agent_profile
679
+
680
+ Get agent profile
681
+
682
+ Retrieve the agents profile
683
+
684
+ ### Example
685
+ ```ruby
686
+ # load the gem
687
+ require 'ultracart_api'
688
+
689
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
690
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
691
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
692
+
693
+
694
+
695
+ begin
696
+ #Get agent profile
697
+ result = api_instance.get_agent_profile
698
+ p result
699
+ rescue UltracartClient::ApiError => e
700
+ puts "Exception when calling ConversationApi->get_agent_profile: #{e}"
701
+ end
702
+ ```
703
+
704
+ ### Parameters
705
+ This endpoint does not need any parameter.
706
+
707
+ ### Return type
708
+
709
+ [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
710
+
711
+ ### Authorization
712
+
713
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
714
+
715
+ ### HTTP request headers
716
+
717
+ - **Content-Type**: application/json
718
+ - **Accept**: application/json
719
+
720
+
721
+
722
+ # **get_agent_websocket_authorization**
723
+ > ConversationAgentAuthResponse get_agent_websocket_authorization
724
+
725
+ Get agent websocket authorization
726
+
727
+ Retrieve a JWT to authorize an agent to make a websocket connection.
728
+
729
+ ### Example
730
+ ```ruby
731
+ # load the gem
732
+ require 'ultracart_api'
733
+
734
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
735
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
736
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
737
+
738
+
739
+
740
+ begin
741
+ #Get agent websocket authorization
742
+ result = api_instance.get_agent_websocket_authorization
743
+ p result
744
+ rescue UltracartClient::ApiError => e
745
+ puts "Exception when calling ConversationApi->get_agent_websocket_authorization: #{e}"
746
+ end
747
+ ```
748
+
749
+ ### Parameters
750
+ This endpoint does not need any parameter.
751
+
752
+ ### Return type
753
+
754
+ [**ConversationAgentAuthResponse**](ConversationAgentAuthResponse.md)
755
+
756
+ ### Authorization
757
+
758
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
759
+
760
+ ### HTTP request headers
761
+
762
+ - **Content-Type**: application/json
763
+ - **Accept**: application/json
764
+
765
+
766
+
767
+ # **get_conversation**
768
+ > ConversationResponse get_conversation(conversation_uuid, opts)
769
+
770
+ Retrieve a conversation
771
+
772
+ Retrieve a conversation including the participants and messages
773
+
774
+ ### Example
775
+ ```ruby
776
+ # load the gem
777
+ require 'ultracart_api'
778
+
779
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
780
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
781
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
782
+
783
+
784
+ conversation_uuid = 'conversation_uuid_example' # String |
785
+
786
+ opts = {
787
+ limit: 56 # Integer |
788
+ }
789
+
790
+ begin
791
+ #Retrieve a conversation
792
+ result = api_instance.get_conversation(conversation_uuid, opts)
793
+ p result
794
+ rescue UltracartClient::ApiError => e
795
+ puts "Exception when calling ConversationApi->get_conversation: #{e}"
796
+ end
797
+ ```
798
+
799
+ ### Parameters
800
+
801
+ Name | Type | Description | Notes
802
+ ------------- | ------------- | ------------- | -------------
803
+ **conversation_uuid** | **String**| |
804
+ **limit** | **Integer**| | [optional]
805
+
806
+ ### Return type
807
+
808
+ [**ConversationResponse**](ConversationResponse.md)
809
+
810
+ ### Authorization
811
+
812
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
813
+
814
+ ### HTTP request headers
815
+
816
+ - **Content-Type**: application/json
817
+ - **Accept**: application/json
818
+
819
+
820
+
821
+ # **get_conversation_canned_messages**
822
+ > ConversationCannedMessagesResponse get_conversation_canned_messages
823
+
824
+ Retrieve a list of canned messages ordered by short_code
825
+
826
+ Retrieve a list of canned messages ordered by short_code
827
+
828
+ ### Example
829
+ ```ruby
830
+ # load the gem
831
+ require 'ultracart_api'
832
+
833
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
834
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
835
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
836
+
837
+
838
+
839
+ begin
840
+ #Retrieve a list of canned messages ordered by short_code
841
+ result = api_instance.get_conversation_canned_messages
842
+ p result
843
+ rescue UltracartClient::ApiError => e
844
+ puts "Exception when calling ConversationApi->get_conversation_canned_messages: #{e}"
845
+ end
846
+ ```
847
+
848
+ ### Parameters
849
+ This endpoint does not need any parameter.
850
+
851
+ ### Return type
852
+
853
+ [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
854
+
855
+ ### Authorization
856
+
857
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
858
+
859
+ ### HTTP request headers
860
+
861
+ - **Content-Type**: application/json
862
+ - **Accept**: application/json
863
+
864
+
865
+
866
+ # **get_conversation_context**
867
+ > ConversationWebchatContext get_conversation_context(conversation_uuid)
868
+
869
+ Get a webchat conversation context
870
+
871
+ Get a webchat conversation context
872
+
873
+ ### Example
874
+ ```ruby
875
+ # load the gem
876
+ require 'ultracart_api'
877
+
878
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
879
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
880
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
881
+
882
+
883
+ conversation_uuid = 'conversation_uuid_example' # String |
884
+
885
+
886
+ begin
887
+ #Get a webchat conversation context
888
+ result = api_instance.get_conversation_context(conversation_uuid)
889
+ p result
890
+ rescue UltracartClient::ApiError => e
891
+ puts "Exception when calling ConversationApi->get_conversation_context: #{e}"
892
+ end
893
+ ```
894
+
895
+ ### Parameters
896
+
897
+ Name | Type | Description | Notes
898
+ ------------- | ------------- | ------------- | -------------
899
+ **conversation_uuid** | **String**| |
900
+
901
+ ### Return type
902
+
903
+ [**ConversationWebchatContext**](ConversationWebchatContext.md)
904
+
905
+ ### Authorization
906
+
907
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
908
+
909
+ ### HTTP request headers
910
+
911
+ - **Content-Type**: application/json
912
+ - **Accept**: application/json
913
+
914
+
915
+
916
+ # **get_conversation_department_member_list**
917
+ > ConversationDepartmentMembersResponse get_conversation_department_member_list
918
+
919
+ Retrieve a list of possible department members
920
+
921
+ Retrieve a list of possible department members
922
+
923
+ ### Example
924
+ ```ruby
925
+ # load the gem
926
+ require 'ultracart_api'
927
+
928
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
929
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
930
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
931
+
932
+
933
+
934
+ begin
935
+ #Retrieve a list of possible department members
936
+ result = api_instance.get_conversation_department_member_list
937
+ p result
938
+ rescue UltracartClient::ApiError => e
939
+ puts "Exception when calling ConversationApi->get_conversation_department_member_list: #{e}"
940
+ end
941
+ ```
942
+
943
+ ### Parameters
944
+ This endpoint does not need any parameter.
945
+
946
+ ### Return type
947
+
948
+ [**ConversationDepartmentMembersResponse**](ConversationDepartmentMembersResponse.md)
949
+
950
+ ### Authorization
951
+
952
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
953
+
954
+ ### HTTP request headers
955
+
956
+ - **Content-Type**: application/json
957
+ - **Accept**: application/json
958
+
959
+
960
+
961
+ # **get_conversation_departments**
962
+ > ConversationDepartmentsResponse get_conversation_departments
963
+
964
+ Retrieve a list of departments ordered by name
965
+
966
+ Retrieve a list of departments ordered by name
967
+
968
+ ### Example
969
+ ```ruby
970
+ # load the gem
971
+ require 'ultracart_api'
972
+
973
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
974
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
975
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
976
+
977
+
978
+
979
+ begin
980
+ #Retrieve a list of departments ordered by name
981
+ result = api_instance.get_conversation_departments
982
+ p result
983
+ rescue UltracartClient::ApiError => e
984
+ puts "Exception when calling ConversationApi->get_conversation_departments: #{e}"
985
+ end
986
+ ```
987
+
988
+ ### Parameters
989
+ This endpoint does not need any parameter.
990
+
991
+ ### Return type
992
+
993
+ [**ConversationDepartmentsResponse**](ConversationDepartmentsResponse.md)
994
+
995
+ ### Authorization
996
+
997
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
998
+
999
+ ### HTTP request headers
1000
+
1001
+ - **Content-Type**: application/json
1002
+ - **Accept**: application/json
1003
+
1004
+
1005
+
1006
+ # **get_conversation_engagement**
1007
+ > ConversationEngagementResponse get_conversation_engagement(conversation_engagement_oid)
1008
+
1009
+ Retrieve an engagement
1010
+
1011
+ Retrieve an engagement
1012
+
1013
+ ### Example
1014
+ ```ruby
1015
+ # load the gem
1016
+ require 'ultracart_api'
1017
+
1018
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1019
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1020
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1021
+
1022
+
1023
+ conversation_engagement_oid = 56 # Integer |
1024
+
1025
+
1026
+ begin
1027
+ #Retrieve an engagement
1028
+ result = api_instance.get_conversation_engagement(conversation_engagement_oid)
1029
+ p result
1030
+ rescue UltracartClient::ApiError => e
1031
+ puts "Exception when calling ConversationApi->get_conversation_engagement: #{e}"
1032
+ end
1033
+ ```
1034
+
1035
+ ### Parameters
1036
+
1037
+ Name | Type | Description | Notes
1038
+ ------------- | ------------- | ------------- | -------------
1039
+ **conversation_engagement_oid** | **Integer**| |
1040
+
1041
+ ### Return type
1042
+
1043
+ [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
1044
+
1045
+ ### Authorization
1046
+
1047
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1048
+
1049
+ ### HTTP request headers
1050
+
1051
+ - **Content-Type**: application/json
1052
+ - **Accept**: application/json
1053
+
1054
+
1055
+
1056
+ # **get_conversation_engagements**
1057
+ > ConversationEngagementsResponse get_conversation_engagements
1058
+
1059
+ Retrieve a list of engagements ordered by name
1060
+
1061
+ Retrieve a list of engagements ordered by name
1062
+
1063
+ ### Example
1064
+ ```ruby
1065
+ # load the gem
1066
+ require 'ultracart_api'
1067
+
1068
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1069
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1070
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1071
+
1072
+
1073
+
1074
+ begin
1075
+ #Retrieve a list of engagements ordered by name
1076
+ result = api_instance.get_conversation_engagements
1077
+ p result
1078
+ rescue UltracartClient::ApiError => e
1079
+ puts "Exception when calling ConversationApi->get_conversation_engagements: #{e}"
1080
+ end
1081
+ ```
1082
+
1083
+ ### Parameters
1084
+ This endpoint does not need any parameter.
1085
+
1086
+ ### Return type
1087
+
1088
+ [**ConversationEngagementsResponse**](ConversationEngagementsResponse.md)
1089
+
1090
+ ### Authorization
1091
+
1092
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1093
+
1094
+ ### HTTP request headers
1095
+
1096
+ - **Content-Type**: application/json
1097
+ - **Accept**: application/json
1098
+
1099
+
1100
+
1101
+ # **get_conversation_messages**
1102
+ > ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
1103
+
1104
+ Retrieve conversation messages
1105
+
1106
+ Retrieve conversation messages since a particular time
1107
+
1108
+ ### Example
1109
+ ```ruby
1110
+ # load the gem
1111
+ require 'ultracart_api'
1112
+
1113
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1114
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1115
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1116
+
1117
+
1118
+ conversation_uuid = 'conversation_uuid_example' # String |
1119
+
1120
+ since = 789 # Integer |
1121
+
1122
+ opts = {
1123
+ limit: 56 # Integer |
1124
+ }
1125
+
1126
+ begin
1127
+ #Retrieve conversation messages
1128
+ result = api_instance.get_conversation_messages(conversation_uuid, since, opts)
1129
+ p result
1130
+ rescue UltracartClient::ApiError => e
1131
+ puts "Exception when calling ConversationApi->get_conversation_messages: #{e}"
1132
+ end
1133
+ ```
1134
+
1135
+ ### Parameters
1136
+
1137
+ Name | Type | Description | Notes
1138
+ ------------- | ------------- | ------------- | -------------
1139
+ **conversation_uuid** | **String**| |
1140
+ **since** | **Integer**| |
1141
+ **limit** | **Integer**| | [optional]
1142
+
1143
+ ### Return type
1144
+
1145
+ [**ConversationMessagesResponse**](ConversationMessagesResponse.md)
1146
+
1147
+ ### Authorization
1148
+
1149
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1150
+
1151
+ ### HTTP request headers
1152
+
1153
+ - **Content-Type**: application/json
1154
+ - **Accept**: application/json
1155
+
1156
+
1157
+
1158
+ # **get_conversation_multimedia_upload_url**
1159
+ > ConversationMultimediaUploadUrlResponse get_conversation_multimedia_upload_url(extension)
1160
+
1161
+ Get a presigned conversation multimedia upload URL
1162
+
1163
+ Get a presigned conversation multimedia upload URL
1164
+
1165
+ ### Example
1166
+ ```ruby
1167
+ # load the gem
1168
+ require 'ultracart_api'
1169
+
1170
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1171
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1172
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1173
+
1174
+
1175
+ extension = 'extension_example' # String |
1176
+
1177
+
1178
+ begin
1179
+ #Get a presigned conversation multimedia upload URL
1180
+ result = api_instance.get_conversation_multimedia_upload_url(extension)
1181
+ p result
1182
+ rescue UltracartClient::ApiError => e
1183
+ puts "Exception when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
1184
+ end
1185
+ ```
1186
+
1187
+ ### Parameters
1188
+
1189
+ Name | Type | Description | Notes
1190
+ ------------- | ------------- | ------------- | -------------
1191
+ **extension** | **String**| |
1192
+
1193
+ ### Return type
1194
+
1195
+ [**ConversationMultimediaUploadUrlResponse**](ConversationMultimediaUploadUrlResponse.md)
1196
+
1197
+ ### Authorization
1198
+
1199
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1200
+
1201
+ ### HTTP request headers
1202
+
1203
+ - **Content-Type**: application/json
1204
+ - **Accept**: application/json
1205
+
1206
+
1207
+
1208
+ # **get_conversation_pbx_audio_upload_url**
1209
+ > ConversationMultimediaUploadUrlResponse get_conversation_pbx_audio_upload_url(extension)
1210
+
1211
+ Get a pre-signed conversation multimedia upload URL
1212
+
1213
+ Get a pre-signed conversation multimedia upload URL
1214
+
1215
+ ### Example
1216
+ ```ruby
1217
+ # load the gem
1218
+ require 'ultracart_api'
1219
+
1220
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1221
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1222
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1223
+
1224
+
1225
+ extension = 'extension_example' # String |
1226
+
1227
+
1228
+ begin
1229
+ #Get a pre-signed conversation multimedia upload URL
1230
+ result = api_instance.get_conversation_pbx_audio_upload_url(extension)
1231
+ p result
1232
+ rescue UltracartClient::ApiError => e
1233
+ puts "Exception when calling ConversationApi->get_conversation_pbx_audio_upload_url: #{e}"
1234
+ end
1235
+ ```
1236
+
1237
+ ### Parameters
1238
+
1239
+ Name | Type | Description | Notes
1240
+ ------------- | ------------- | ------------- | -------------
1241
+ **extension** | **String**| |
1242
+
1243
+ ### Return type
1244
+
1245
+ [**ConversationMultimediaUploadUrlResponse**](ConversationMultimediaUploadUrlResponse.md)
1246
+
1247
+ ### Authorization
1248
+
1249
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1250
+
1251
+ ### HTTP request headers
1252
+
1253
+ - **Content-Type**: application/json
1254
+ - **Accept**: application/json
1255
+
1256
+
1257
+
1258
+ # **get_conversation_pbx_customer_snapshot**
1259
+ > ConversationPbxCustomerSnapshotResponse get_conversation_pbx_customer_snapshot(pbx_customer_snapshot_request)
1260
+
1261
+ Get orders and customer information for a phone number
1262
+
1263
+ Retrieves all the orders, auto orders, and customer profile for a given phone number
1264
+
1265
+ ### Example
1266
+ ```ruby
1267
+ # load the gem
1268
+ require 'ultracart_api'
1269
+
1270
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1271
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1272
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1273
+
1274
+
1275
+ pbx_customer_snapshot_request = UltracartClient::ConversationPbxCustomerSnapshotRequest.new # ConversationPbxCustomerSnapshotRequest | Conversation pbx customer snapshot request
1276
+
1277
+
1278
+ begin
1279
+ #Get orders and customer information for a phone number
1280
+ result = api_instance.get_conversation_pbx_customer_snapshot(pbx_customer_snapshot_request)
1281
+ p result
1282
+ rescue UltracartClient::ApiError => e
1283
+ puts "Exception when calling ConversationApi->get_conversation_pbx_customer_snapshot: #{e}"
1284
+ end
1285
+ ```
1286
+
1287
+ ### Parameters
1288
+
1289
+ Name | Type | Description | Notes
1290
+ ------------- | ------------- | ------------- | -------------
1291
+ **pbx_customer_snapshot_request** | [**ConversationPbxCustomerSnapshotRequest**](ConversationPbxCustomerSnapshotRequest.md)| Conversation pbx customer snapshot request |
1292
+
1293
+ ### Return type
1294
+
1295
+ [**ConversationPbxCustomerSnapshotResponse**](ConversationPbxCustomerSnapshotResponse.md)
1296
+
1297
+ ### Authorization
1298
+
1299
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1300
+
1301
+ ### HTTP request headers
1302
+
1303
+ - **Content-Type**: application/json
1304
+ - **Accept**: application/json
1305
+
1306
+
1307
+
1308
+ # **get_conversation_permissions**
1309
+ > ConversationPermissionsResponse get_conversation_permissions
1310
+
1311
+ Retrieve conversation permissions
1312
+
1313
+ Retrieve conversation permissions
1314
+
1315
+ ### Example
1316
+ ```ruby
1317
+ # load the gem
1318
+ require 'ultracart_api'
1319
+
1320
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1321
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1322
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1323
+
1324
+
1325
+
1326
+ begin
1327
+ #Retrieve conversation permissions
1328
+ result = api_instance.get_conversation_permissions
1329
+ p result
1330
+ rescue UltracartClient::ApiError => e
1331
+ puts "Exception when calling ConversationApi->get_conversation_permissions: #{e}"
1332
+ end
1333
+ ```
1334
+
1335
+ ### Parameters
1336
+ This endpoint does not need any parameter.
1337
+
1338
+ ### Return type
1339
+
1340
+ [**ConversationPermissionsResponse**](ConversationPermissionsResponse.md)
1341
+
1342
+ ### Authorization
1343
+
1344
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1345
+
1346
+ ### HTTP request headers
1347
+
1348
+ - **Content-Type**: application/json
1349
+ - **Accept**: application/json
1350
+
1351
+
1352
+
1353
+ # **get_conversation_webchat_queue_statuses**
1354
+ > ConversationWebchatQueueStatusesResponse get_conversation_webchat_queue_statuses
1355
+
1356
+ Retrieve a conversation webchat queue statuses
1357
+
1358
+ Retrieve a conversation webchat queue statuses including agent status and queue entries
1359
+
1360
+ ### Example
1361
+ ```ruby
1362
+ # load the gem
1363
+ require 'ultracart_api'
1364
+
1365
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1366
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1367
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1368
+
1369
+
1370
+
1371
+ begin
1372
+ #Retrieve a conversation webchat queue statuses
1373
+ result = api_instance.get_conversation_webchat_queue_statuses
1374
+ p result
1375
+ rescue UltracartClient::ApiError => e
1376
+ puts "Exception when calling ConversationApi->get_conversation_webchat_queue_statuses: #{e}"
1377
+ end
1378
+ ```
1379
+
1380
+ ### Parameters
1381
+ This endpoint does not need any parameter.
1382
+
1383
+ ### Return type
1384
+
1385
+ [**ConversationWebchatQueueStatusesResponse**](ConversationWebchatQueueStatusesResponse.md)
1386
+
1387
+ ### Authorization
1388
+
1389
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1390
+
1391
+ ### HTTP request headers
1392
+
1393
+ - **Content-Type**: application/json
1394
+ - **Accept**: application/json
1395
+
1396
+
1397
+
1398
+ # **get_conversations**
1399
+ > ConversationsResponse get_conversations(opts)
1400
+
1401
+ Retrieve a list of conversation summaries newest to oldest
1402
+
1403
+ Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
1404
+
1405
+ ### Example
1406
+ ```ruby
1407
+ # load the gem
1408
+ require 'ultracart_api'
1409
+
1410
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1411
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1412
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1413
+
1414
+
1415
+ opts = {
1416
+ medium: 'medium_example', # String |
1417
+ before: 'before_example', # String |
1418
+ _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
1419
+ _offset: 0 # Integer | Pagination of the record set. Offset is a zero based index.
1420
+ }
1421
+
1422
+ begin
1423
+ #Retrieve a list of conversation summaries newest to oldest
1424
+ result = api_instance.get_conversations(opts)
1425
+ p result
1426
+ rescue UltracartClient::ApiError => e
1427
+ puts "Exception when calling ConversationApi->get_conversations: #{e}"
1428
+ end
1429
+ ```
1430
+
1431
+ ### Parameters
1432
+
1433
+ Name | Type | Description | Notes
1434
+ ------------- | ------------- | ------------- | -------------
1435
+ **medium** | **String**| | [optional]
1436
+ **before** | **String**| | [optional]
1437
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
1438
+ **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
1439
+
1440
+ ### Return type
1441
+
1442
+ [**ConversationsResponse**](ConversationsResponse.md)
1443
+
1444
+ ### Authorization
1445
+
1446
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1447
+
1448
+ ### HTTP request headers
1449
+
1450
+ - **Content-Type**: application/json
1451
+ - **Accept**: application/json
1452
+
1453
+
1454
+
1455
+ # **get_conversations_autocomplete**
1456
+ > ConversationAutocompleteResponse get_conversations_autocomplete(autocomplete_request)
1457
+
1458
+ Retrieve a list of matching terms for a search field
1459
+
1460
+ Retrieve a list of matching terms for a search field
1461
+
1462
+ ### Example
1463
+ ```ruby
1464
+ # load the gem
1465
+ require 'ultracart_api'
1466
+
1467
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1468
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1469
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1470
+
1471
+
1472
+ autocomplete_request = UltracartClient::ConversationAutocompleteRequest.new # ConversationAutocompleteRequest | Autocomplete Request
1473
+
1474
+
1475
+ begin
1476
+ #Retrieve a list of matching terms for a search field
1477
+ result = api_instance.get_conversations_autocomplete(autocomplete_request)
1478
+ p result
1479
+ rescue UltracartClient::ApiError => e
1480
+ puts "Exception when calling ConversationApi->get_conversations_autocomplete: #{e}"
1481
+ end
1482
+ ```
1483
+
1484
+ ### Parameters
1485
+
1486
+ Name | Type | Description | Notes
1487
+ ------------- | ------------- | ------------- | -------------
1488
+ **autocomplete_request** | [**ConversationAutocompleteRequest**](ConversationAutocompleteRequest.md)| Autocomplete Request |
1489
+
1490
+ ### Return type
1491
+
1492
+ [**ConversationAutocompleteResponse**](ConversationAutocompleteResponse.md)
1493
+
1494
+ ### Authorization
1495
+
1496
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1497
+
1498
+ ### HTTP request headers
1499
+
1500
+ - **Content-Type**: application/json
1501
+ - **Accept**: application/json
1502
+
1503
+
1504
+
1505
+ # **get_conversations_search**
1506
+ > ConversationSearchResponse get_conversations_search(search_request)
1507
+
1508
+ Search conversations
1509
+
1510
+ Search conversations
1511
+
1512
+ ### Example
1513
+ ```ruby
1514
+ # load the gem
1515
+ require 'ultracart_api'
1516
+
1517
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1518
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1519
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1520
+
1521
+
1522
+ search_request = UltracartClient::ConversationSearchRequest.new # ConversationSearchRequest | Search Request
1523
+
1524
+
1525
+ begin
1526
+ #Search conversations
1527
+ result = api_instance.get_conversations_search(search_request)
1528
+ p result
1529
+ rescue UltracartClient::ApiError => e
1530
+ puts "Exception when calling ConversationApi->get_conversations_search: #{e}"
1531
+ end
1532
+ ```
1533
+
1534
+ ### Parameters
1535
+
1536
+ Name | Type | Description | Notes
1537
+ ------------- | ------------- | ------------- | -------------
1538
+ **search_request** | [**ConversationSearchRequest**](ConversationSearchRequest.md)| Search Request |
1539
+
1540
+ ### Return type
1541
+
1542
+ [**ConversationSearchResponse**](ConversationSearchResponse.md)
1543
+
1544
+ ### Authorization
1545
+
1546
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1547
+
1548
+ ### HTTP request headers
1549
+
1550
+ - **Content-Type**: application/json
1551
+ - **Accept**: application/json
1552
+
1553
+
1554
+
1555
+ # **get_locations_for_engagement**
1556
+ > ConversationLocationsResponse get_locations_for_engagement
1557
+
1558
+ Get location data for engagement configuration
1559
+
1560
+ Get location data for engagement configuration
1561
+
1562
+ ### Example
1563
+ ```ruby
1564
+ # load the gem
1565
+ require 'ultracart_api'
1566
+
1567
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1568
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1569
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1570
+
1571
+
1572
+
1573
+ begin
1574
+ #Get location data for engagement configuration
1575
+ result = api_instance.get_locations_for_engagement
1576
+ p result
1577
+ rescue UltracartClient::ApiError => e
1578
+ puts "Exception when calling ConversationApi->get_locations_for_engagement: #{e}"
1579
+ end
1580
+ ```
1581
+
1582
+ ### Parameters
1583
+ This endpoint does not need any parameter.
1584
+
1585
+ ### Return type
1586
+
1587
+ [**ConversationLocationsResponse**](ConversationLocationsResponse.md)
1588
+
1589
+ ### Authorization
1590
+
1591
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1592
+
1593
+ ### HTTP request headers
1594
+
1595
+ - **Content-Type**: application/json
1596
+ - **Accept**: application/json
1597
+
1598
+
1599
+
1600
+ # **get_pbx_agent**
1601
+ > ConversationPbxAgentResponse get_pbx_agent(conversation_pbx_agent_uuid)
1602
+
1603
+ Get pbx agent
1604
+
1605
+ Retrieve a pbx agent
1606
+
1607
+ ### Example
1608
+ ```ruby
1609
+ # load the gem
1610
+ require 'ultracart_api'
1611
+
1612
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1613
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1614
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1615
+
1616
+
1617
+ conversation_pbx_agent_uuid = 'conversation_pbx_agent_uuid_example' # String |
1618
+
1619
+
1620
+ begin
1621
+ #Get pbx agent
1622
+ result = api_instance.get_pbx_agent(conversation_pbx_agent_uuid)
1623
+ p result
1624
+ rescue UltracartClient::ApiError => e
1625
+ puts "Exception when calling ConversationApi->get_pbx_agent: #{e}"
1626
+ end
1627
+ ```
1628
+
1629
+ ### Parameters
1630
+
1631
+ Name | Type | Description | Notes
1632
+ ------------- | ------------- | ------------- | -------------
1633
+ **conversation_pbx_agent_uuid** | **String**| |
1634
+
1635
+ ### Return type
1636
+
1637
+ [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
1638
+
1639
+ ### Authorization
1640
+
1641
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1642
+
1643
+ ### HTTP request headers
1644
+
1645
+ - **Content-Type**: application/json
1646
+ - **Accept**: application/json
1647
+
1648
+
1649
+
1650
+ # **get_pbx_agents**
1651
+ > ConversationPbxAgentsResponse get_pbx_agents
1652
+
1653
+ Get pbx agents
1654
+
1655
+ Retrieve pbx agents
1656
+
1657
+ ### Example
1658
+ ```ruby
1659
+ # load the gem
1660
+ require 'ultracart_api'
1661
+
1662
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1663
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1664
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1665
+
1666
+
1667
+
1668
+ begin
1669
+ #Get pbx agents
1670
+ result = api_instance.get_pbx_agents
1671
+ p result
1672
+ rescue UltracartClient::ApiError => e
1673
+ puts "Exception when calling ConversationApi->get_pbx_agents: #{e}"
1674
+ end
1675
+ ```
1676
+
1677
+ ### Parameters
1678
+ This endpoint does not need any parameter.
1679
+
1680
+ ### Return type
1681
+
1682
+ [**ConversationPbxAgentsResponse**](ConversationPbxAgentsResponse.md)
1683
+
1684
+ ### Authorization
1685
+
1686
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1687
+
1688
+ ### HTTP request headers
1689
+
1690
+ - **Content-Type**: application/json
1691
+ - **Accept**: application/json
1692
+
1693
+
1694
+
1695
+ # **get_pbx_audio**
1696
+ > ConversationPbxAudioResponse get_pbx_audio(conversation_pbx_audio_uuid)
1697
+
1698
+ Get pbx audio
1699
+
1700
+ Retrieve a pbx audio
1701
+
1702
+ ### Example
1703
+ ```ruby
1704
+ # load the gem
1705
+ require 'ultracart_api'
1706
+
1707
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1708
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1709
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1710
+
1711
+
1712
+ conversation_pbx_audio_uuid = 'conversation_pbx_audio_uuid_example' # String |
1713
+
1714
+
1715
+ begin
1716
+ #Get pbx audio
1717
+ result = api_instance.get_pbx_audio(conversation_pbx_audio_uuid)
1718
+ p result
1719
+ rescue UltracartClient::ApiError => e
1720
+ puts "Exception when calling ConversationApi->get_pbx_audio: #{e}"
1721
+ end
1722
+ ```
1723
+
1724
+ ### Parameters
1725
+
1726
+ Name | Type | Description | Notes
1727
+ ------------- | ------------- | ------------- | -------------
1728
+ **conversation_pbx_audio_uuid** | **String**| |
1729
+
1730
+ ### Return type
1731
+
1732
+ [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
1733
+
1734
+ ### Authorization
1735
+
1736
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1737
+
1738
+ ### HTTP request headers
1739
+
1740
+ - **Content-Type**: application/json
1741
+ - **Accept**: application/json
1742
+
1743
+
1744
+
1745
+ # **get_pbx_audios**
1746
+ > ConversationPbxAudiosResponse get_pbx_audios
1747
+
1748
+ Get pbx audios
1749
+
1750
+ Retrieve pbx audios
1751
+
1752
+ ### Example
1753
+ ```ruby
1754
+ # load the gem
1755
+ require 'ultracart_api'
1756
+
1757
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1758
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1759
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1760
+
1761
+
1762
+
1763
+ begin
1764
+ #Get pbx audios
1765
+ result = api_instance.get_pbx_audios
1766
+ p result
1767
+ rescue UltracartClient::ApiError => e
1768
+ puts "Exception when calling ConversationApi->get_pbx_audios: #{e}"
1769
+ end
1770
+ ```
1771
+
1772
+ ### Parameters
1773
+ This endpoint does not need any parameter.
1774
+
1775
+ ### Return type
1776
+
1777
+ [**ConversationPbxAudiosResponse**](ConversationPbxAudiosResponse.md)
1778
+
1779
+ ### Authorization
1780
+
1781
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1782
+
1783
+ ### HTTP request headers
1784
+
1785
+ - **Content-Type**: application/json
1786
+ - **Accept**: application/json
1787
+
1788
+
1789
+
1790
+ # **get_pbx_menu**
1791
+ > ConversationPbxMenuResponse get_pbx_menu(conversation_pbx_menu_uuid)
1792
+
1793
+ Get pbx menu
1794
+
1795
+ Retrieve a pbx menu
1796
+
1797
+ ### Example
1798
+ ```ruby
1799
+ # load the gem
1800
+ require 'ultracart_api'
1801
+
1802
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1803
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1804
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1805
+
1806
+
1807
+ conversation_pbx_menu_uuid = 'conversation_pbx_menu_uuid_example' # String |
1808
+
1809
+
1810
+ begin
1811
+ #Get pbx menu
1812
+ result = api_instance.get_pbx_menu(conversation_pbx_menu_uuid)
1813
+ p result
1814
+ rescue UltracartClient::ApiError => e
1815
+ puts "Exception when calling ConversationApi->get_pbx_menu: #{e}"
1816
+ end
1817
+ ```
1818
+
1819
+ ### Parameters
1820
+
1821
+ Name | Type | Description | Notes
1822
+ ------------- | ------------- | ------------- | -------------
1823
+ **conversation_pbx_menu_uuid** | **String**| |
1824
+
1825
+ ### Return type
1826
+
1827
+ [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
1828
+
1829
+ ### Authorization
1830
+
1831
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1832
+
1833
+ ### HTTP request headers
1834
+
1835
+ - **Content-Type**: application/json
1836
+ - **Accept**: application/json
1837
+
1838
+
1839
+
1840
+ # **get_pbx_menus**
1841
+ > ConversationPbxMenusResponse get_pbx_menus
1842
+
1843
+ Get pbx menus
1844
+
1845
+ Retrieve pbx menus
1846
+
1847
+ ### Example
1848
+ ```ruby
1849
+ # load the gem
1850
+ require 'ultracart_api'
1851
+
1852
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1853
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1854
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1855
+
1856
+
1857
+
1858
+ begin
1859
+ #Get pbx menus
1860
+ result = api_instance.get_pbx_menus
1861
+ p result
1862
+ rescue UltracartClient::ApiError => e
1863
+ puts "Exception when calling ConversationApi->get_pbx_menus: #{e}"
1864
+ end
1865
+ ```
1866
+
1867
+ ### Parameters
1868
+ This endpoint does not need any parameter.
1869
+
1870
+ ### Return type
1871
+
1872
+ [**ConversationPbxMenusResponse**](ConversationPbxMenusResponse.md)
1873
+
1874
+ ### Authorization
1875
+
1876
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1877
+
1878
+ ### HTTP request headers
1879
+
1880
+ - **Content-Type**: application/json
1881
+ - **Accept**: application/json
1882
+
1883
+
1884
+
1885
+ # **get_pbx_phone_number**
1886
+ > ConversationPbxPhoneNumberResponse get_pbx_phone_number(conversation_pbx_phone_number_uuid)
1887
+
1888
+ Get pbx phoneNumber
1889
+
1890
+ Retrieve a pbx phoneNumber
1891
+
1892
+ ### Example
1893
+ ```ruby
1894
+ # load the gem
1895
+ require 'ultracart_api'
1896
+
1897
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1898
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1899
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1900
+
1901
+
1902
+ conversation_pbx_phone_number_uuid = 'conversation_pbx_phone_number_uuid_example' # String |
1903
+
1904
+
1905
+ begin
1906
+ #Get pbx phoneNumber
1907
+ result = api_instance.get_pbx_phone_number(conversation_pbx_phone_number_uuid)
1908
+ p result
1909
+ rescue UltracartClient::ApiError => e
1910
+ puts "Exception when calling ConversationApi->get_pbx_phone_number: #{e}"
1911
+ end
1912
+ ```
1913
+
1914
+ ### Parameters
1915
+
1916
+ Name | Type | Description | Notes
1917
+ ------------- | ------------- | ------------- | -------------
1918
+ **conversation_pbx_phone_number_uuid** | **String**| |
1919
+
1920
+ ### Return type
1921
+
1922
+ [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
1923
+
1924
+ ### Authorization
1925
+
1926
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1927
+
1928
+ ### HTTP request headers
1929
+
1930
+ - **Content-Type**: application/json
1931
+ - **Accept**: application/json
1932
+
1933
+
1934
+
1935
+ # **get_pbx_phone_numbers**
1936
+ > ConversationPbxPhoneNumbersResponse get_pbx_phone_numbers
1937
+
1938
+ Get pbx phoneNumbers
1939
+
1940
+ Retrieve pbx phoneNumbers
1941
+
1942
+ ### Example
1943
+ ```ruby
1944
+ # load the gem
1945
+ require 'ultracart_api'
1946
+
1947
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1948
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1949
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1950
+
1951
+
1952
+
1953
+ begin
1954
+ #Get pbx phoneNumbers
1955
+ result = api_instance.get_pbx_phone_numbers
1956
+ p result
1957
+ rescue UltracartClient::ApiError => e
1958
+ puts "Exception when calling ConversationApi->get_pbx_phone_numbers: #{e}"
1959
+ end
1960
+ ```
1961
+
1962
+ ### Parameters
1963
+ This endpoint does not need any parameter.
1964
+
1965
+ ### Return type
1966
+
1967
+ [**ConversationPbxPhoneNumbersResponse**](ConversationPbxPhoneNumbersResponse.md)
1968
+
1969
+ ### Authorization
1970
+
1971
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1972
+
1973
+ ### HTTP request headers
1974
+
1975
+ - **Content-Type**: application/json
1976
+ - **Accept**: application/json
1977
+
1978
+
1979
+
1980
+ # **get_pbx_queue**
1981
+ > ConversationPbxQueueResponse get_pbx_queue(conversation_pbx_queue_uuid)
1982
+
1983
+ Get pbx queue
1984
+
1985
+ Retrieve a pbx queue
1986
+
1987
+ ### Example
1988
+ ```ruby
1989
+ # load the gem
1990
+ require 'ultracart_api'
1991
+
1992
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1993
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1994
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1995
+
1996
+
1997
+ conversation_pbx_queue_uuid = 'conversation_pbx_queue_uuid_example' # String |
1998
+
1999
+
2000
+ begin
2001
+ #Get pbx queue
2002
+ result = api_instance.get_pbx_queue(conversation_pbx_queue_uuid)
2003
+ p result
2004
+ rescue UltracartClient::ApiError => e
2005
+ puts "Exception when calling ConversationApi->get_pbx_queue: #{e}"
2006
+ end
2007
+ ```
2008
+
2009
+ ### Parameters
2010
+
2011
+ Name | Type | Description | Notes
2012
+ ------------- | ------------- | ------------- | -------------
2013
+ **conversation_pbx_queue_uuid** | **String**| |
2014
+
2015
+ ### Return type
2016
+
2017
+ [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
2018
+
2019
+ ### Authorization
2020
+
2021
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2022
+
2023
+ ### HTTP request headers
2024
+
2025
+ - **Content-Type**: application/json
2026
+ - **Accept**: application/json
2027
+
195
2028
 
196
- Called periodically by the conversation API to keep the session alive.
2029
+
2030
+ # **get_pbx_queues**
2031
+ > ConversationPbxQueuesResponse get_pbx_queues
2032
+
2033
+ Get pbx queues
2034
+
2035
+ Retrieve pbx queues
197
2036
 
198
2037
  ### Example
199
2038
  ```ruby
@@ -207,10 +2046,11 @@ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, fa
207
2046
 
208
2047
 
209
2048
  begin
210
- #Agent keep alive
211
- api_instance.get_agent_keep_alive
2049
+ #Get pbx queues
2050
+ result = api_instance.get_pbx_queues
2051
+ p result
212
2052
  rescue UltracartClient::ApiError => e
213
- puts "Exception when calling ConversationApi->get_agent_keep_alive: #{e}"
2053
+ puts "Exception when calling ConversationApi->get_pbx_queues: #{e}"
214
2054
  end
215
2055
  ```
216
2056
 
@@ -219,7 +2059,7 @@ This endpoint does not need any parameter.
219
2059
 
220
2060
  ### Return type
221
2061
 
222
- nil (empty response body)
2062
+ [**ConversationPbxQueuesResponse**](ConversationPbxQueuesResponse.md)
223
2063
 
224
2064
  ### Authorization
225
2065
 
@@ -232,12 +2072,12 @@ nil (empty response body)
232
2072
 
233
2073
 
234
2074
 
235
- # **get_agent_profile**
236
- > ConversationAgentProfileResponse get_agent_profile
2075
+ # **get_pbx_time_based**
2076
+ > ConversationPbxTimeBasedResponse get_pbx_time_based(conversation_pbx_time_based_uuid)
237
2077
 
238
- Get agent profile
2078
+ Get pbx timeBased
239
2079
 
240
- Retrieve the agents profile
2080
+ Retrieve a pbx timeBased
241
2081
 
242
2082
  ### Example
243
2083
  ```ruby
@@ -249,13 +2089,63 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
249
2089
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
250
2090
 
251
2091
 
2092
+ conversation_pbx_time_based_uuid = 'conversation_pbx_time_based_uuid_example' # String |
2093
+
252
2094
 
253
2095
  begin
254
- #Get agent profile
255
- result = api_instance.get_agent_profile
2096
+ #Get pbx timeBased
2097
+ result = api_instance.get_pbx_time_based(conversation_pbx_time_based_uuid)
256
2098
  p result
257
2099
  rescue UltracartClient::ApiError => e
258
- puts "Exception when calling ConversationApi->get_agent_profile: #{e}"
2100
+ puts "Exception when calling ConversationApi->get_pbx_time_based: #{e}"
2101
+ end
2102
+ ```
2103
+
2104
+ ### Parameters
2105
+
2106
+ Name | Type | Description | Notes
2107
+ ------------- | ------------- | ------------- | -------------
2108
+ **conversation_pbx_time_based_uuid** | **String**| |
2109
+
2110
+ ### Return type
2111
+
2112
+ [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
2113
+
2114
+ ### Authorization
2115
+
2116
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2117
+
2118
+ ### HTTP request headers
2119
+
2120
+ - **Content-Type**: application/json
2121
+ - **Accept**: application/json
2122
+
2123
+
2124
+
2125
+ # **get_pbx_time_baseds**
2126
+ > ConversationPbxTimeBasedsResponse get_pbx_time_baseds
2127
+
2128
+ Get pbx timeBaseds
2129
+
2130
+ Retrieve pbx timeBaseds
2131
+
2132
+ ### Example
2133
+ ```ruby
2134
+ # load the gem
2135
+ require 'ultracart_api'
2136
+
2137
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2138
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2139
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2140
+
2141
+
2142
+
2143
+ begin
2144
+ #Get pbx timeBaseds
2145
+ result = api_instance.get_pbx_time_baseds
2146
+ p result
2147
+ rescue UltracartClient::ApiError => e
2148
+ puts "Exception when calling ConversationApi->get_pbx_time_baseds: #{e}"
259
2149
  end
260
2150
  ```
261
2151
 
@@ -264,7 +2154,7 @@ This endpoint does not need any parameter.
264
2154
 
265
2155
  ### Return type
266
2156
 
267
- [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
2157
+ [**ConversationPbxTimeBasedsResponse**](ConversationPbxTimeBasedsResponse.md)
268
2158
 
269
2159
  ### Authorization
270
2160
 
@@ -277,12 +2167,202 @@ This endpoint does not need any parameter.
277
2167
 
278
2168
 
279
2169
 
280
- # **get_agent_websocket_authorization**
281
- > ConversationAgentAuthResponse get_agent_websocket_authorization
2170
+ # **get_pbx_time_range**
2171
+ > ConversationPbxTimeRangeResponse get_pbx_time_range(conversation_pbx_time_range_uuid)
282
2172
 
283
- Get agent websocket authorization
2173
+ Get pbx timeRange
284
2174
 
285
- Retrieve a JWT to authorize an agent to make a websocket connection.
2175
+ Retrieve a pbx timeRange
2176
+
2177
+ ### Example
2178
+ ```ruby
2179
+ # load the gem
2180
+ require 'ultracart_api'
2181
+
2182
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2183
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2184
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2185
+
2186
+
2187
+ conversation_pbx_time_range_uuid = 'conversation_pbx_time_range_uuid_example' # String |
2188
+
2189
+
2190
+ begin
2191
+ #Get pbx timeRange
2192
+ result = api_instance.get_pbx_time_range(conversation_pbx_time_range_uuid)
2193
+ p result
2194
+ rescue UltracartClient::ApiError => e
2195
+ puts "Exception when calling ConversationApi->get_pbx_time_range: #{e}"
2196
+ end
2197
+ ```
2198
+
2199
+ ### Parameters
2200
+
2201
+ Name | Type | Description | Notes
2202
+ ------------- | ------------- | ------------- | -------------
2203
+ **conversation_pbx_time_range_uuid** | **String**| |
2204
+
2205
+ ### Return type
2206
+
2207
+ [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
2208
+
2209
+ ### Authorization
2210
+
2211
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2212
+
2213
+ ### HTTP request headers
2214
+
2215
+ - **Content-Type**: application/json
2216
+ - **Accept**: application/json
2217
+
2218
+
2219
+
2220
+ # **get_pbx_time_ranges**
2221
+ > ConversationPbxTimeRangesResponse get_pbx_time_ranges
2222
+
2223
+ Get pbx timeRanges
2224
+
2225
+ Retrieve pbx timeRanges
2226
+
2227
+ ### Example
2228
+ ```ruby
2229
+ # load the gem
2230
+ require 'ultracart_api'
2231
+
2232
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2233
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2234
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2235
+
2236
+
2237
+
2238
+ begin
2239
+ #Get pbx timeRanges
2240
+ result = api_instance.get_pbx_time_ranges
2241
+ p result
2242
+ rescue UltracartClient::ApiError => e
2243
+ puts "Exception when calling ConversationApi->get_pbx_time_ranges: #{e}"
2244
+ end
2245
+ ```
2246
+
2247
+ ### Parameters
2248
+ This endpoint does not need any parameter.
2249
+
2250
+ ### Return type
2251
+
2252
+ [**ConversationPbxTimeRangesResponse**](ConversationPbxTimeRangesResponse.md)
2253
+
2254
+ ### Authorization
2255
+
2256
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2257
+
2258
+ ### HTTP request headers
2259
+
2260
+ - **Content-Type**: application/json
2261
+ - **Accept**: application/json
2262
+
2263
+
2264
+
2265
+ # **get_pbx_voicemail_mailbox**
2266
+ > ConversationPbxVoicemailMailboxResponse get_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
2267
+
2268
+ Get pbx voicemailMailbox
2269
+
2270
+ Retrieve a pbx voicemailMailbox
2271
+
2272
+ ### Example
2273
+ ```ruby
2274
+ # load the gem
2275
+ require 'ultracart_api'
2276
+
2277
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2278
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2279
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2280
+
2281
+
2282
+ conversation_pbx_voicemail_mailbox_uuid = 'conversation_pbx_voicemail_mailbox_uuid_example' # String |
2283
+
2284
+
2285
+ begin
2286
+ #Get pbx voicemailMailbox
2287
+ result = api_instance.get_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
2288
+ p result
2289
+ rescue UltracartClient::ApiError => e
2290
+ puts "Exception when calling ConversationApi->get_pbx_voicemail_mailbox: #{e}"
2291
+ end
2292
+ ```
2293
+
2294
+ ### Parameters
2295
+
2296
+ Name | Type | Description | Notes
2297
+ ------------- | ------------- | ------------- | -------------
2298
+ **conversation_pbx_voicemail_mailbox_uuid** | **String**| |
2299
+
2300
+ ### Return type
2301
+
2302
+ [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
2303
+
2304
+ ### Authorization
2305
+
2306
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2307
+
2308
+ ### HTTP request headers
2309
+
2310
+ - **Content-Type**: application/json
2311
+ - **Accept**: application/json
2312
+
2313
+
2314
+
2315
+ # **get_pbx_voicemail_mailboxes**
2316
+ > ConversationPbxVoicemailMailboxesResponse get_pbx_voicemail_mailboxes
2317
+
2318
+ Get pbx voicemailMailboxes
2319
+
2320
+ Retrieve pbx voicemailMailboxes
2321
+
2322
+ ### Example
2323
+ ```ruby
2324
+ # load the gem
2325
+ require 'ultracart_api'
2326
+
2327
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2328
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2329
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2330
+
2331
+
2332
+
2333
+ begin
2334
+ #Get pbx voicemailMailboxes
2335
+ result = api_instance.get_pbx_voicemail_mailboxes
2336
+ p result
2337
+ rescue UltracartClient::ApiError => e
2338
+ puts "Exception when calling ConversationApi->get_pbx_voicemail_mailboxes: #{e}"
2339
+ end
2340
+ ```
2341
+
2342
+ ### Parameters
2343
+ This endpoint does not need any parameter.
2344
+
2345
+ ### Return type
2346
+
2347
+ [**ConversationPbxVoicemailMailboxesResponse**](ConversationPbxVoicemailMailboxesResponse.md)
2348
+
2349
+ ### Authorization
2350
+
2351
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2352
+
2353
+ ### HTTP request headers
2354
+
2355
+ - **Content-Type**: application/json
2356
+ - **Accept**: application/json
2357
+
2358
+
2359
+
2360
+ # **insert_conversation_canned_message**
2361
+ > ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
2362
+
2363
+ Insert a canned message
2364
+
2365
+ Insert a canned message
286
2366
 
287
2367
  ### Example
288
2368
  ```ruby
@@ -294,22 +2374,27 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
294
2374
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
295
2375
 
296
2376
 
2377
+ canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
2378
+
297
2379
 
298
2380
  begin
299
- #Get agent websocket authorization
300
- result = api_instance.get_agent_websocket_authorization
2381
+ #Insert a canned message
2382
+ result = api_instance.insert_conversation_canned_message(canned_message)
301
2383
  p result
302
2384
  rescue UltracartClient::ApiError => e
303
- puts "Exception when calling ConversationApi->get_agent_websocket_authorization: #{e}"
2385
+ puts "Exception when calling ConversationApi->insert_conversation_canned_message: #{e}"
304
2386
  end
305
2387
  ```
306
2388
 
307
2389
  ### Parameters
308
- This endpoint does not need any parameter.
2390
+
2391
+ Name | Type | Description | Notes
2392
+ ------------- | ------------- | ------------- | -------------
2393
+ **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
309
2394
 
310
2395
  ### Return type
311
2396
 
312
- [**ConversationAgentAuthResponse**](ConversationAgentAuthResponse.md)
2397
+ [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
313
2398
 
314
2399
  ### Authorization
315
2400
 
@@ -322,12 +2407,12 @@ This endpoint does not need any parameter.
322
2407
 
323
2408
 
324
2409
 
325
- # **get_conversation**
326
- > ConversationResponse get_conversation(conversation_uuid, opts)
2410
+ # **insert_conversation_department**
2411
+ > ConversationDepartmentResponse insert_conversation_department(department)
327
2412
 
328
- Retrieve a conversation
2413
+ Insert a department
329
2414
 
330
- Retrieve a conversation including the participants and messages
2415
+ Insert a department
331
2416
 
332
2417
  ### Example
333
2418
  ```ruby
@@ -339,18 +2424,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
339
2424
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
340
2425
 
341
2426
 
342
- conversation_uuid = 'conversation_uuid_example' # String |
2427
+ department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
343
2428
 
344
- opts = {
345
- limit: 56 # Integer |
346
- }
347
2429
 
348
2430
  begin
349
- #Retrieve a conversation
350
- result = api_instance.get_conversation(conversation_uuid, opts)
2431
+ #Insert a department
2432
+ result = api_instance.insert_conversation_department(department)
351
2433
  p result
352
2434
  rescue UltracartClient::ApiError => e
353
- puts "Exception when calling ConversationApi->get_conversation: #{e}"
2435
+ puts "Exception when calling ConversationApi->insert_conversation_department: #{e}"
354
2436
  end
355
2437
  ```
356
2438
 
@@ -358,12 +2440,11 @@ end
358
2440
 
359
2441
  Name | Type | Description | Notes
360
2442
  ------------- | ------------- | ------------- | -------------
361
- **conversation_uuid** | **String**| |
362
- **limit** | **Integer**| | [optional]
2443
+ **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
363
2444
 
364
2445
  ### Return type
365
2446
 
366
- [**ConversationResponse**](ConversationResponse.md)
2447
+ [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
367
2448
 
368
2449
  ### Authorization
369
2450
 
@@ -376,12 +2457,12 @@ Name | Type | Description | Notes
376
2457
 
377
2458
 
378
2459
 
379
- # **get_conversation_canned_messages**
380
- > ConversationCannedMessagesResponse get_conversation_canned_messages
2460
+ # **insert_conversation_engagement**
2461
+ > ConversationEngagementResponse insert_conversation_engagement(engagement)
381
2462
 
382
- Retrieve a list of canned messages ordered by short_code
2463
+ Insert a engagement
383
2464
 
384
- Retrieve a list of canned messages ordered by short_code
2465
+ Insert a engagement
385
2466
 
386
2467
  ### Example
387
2468
  ```ruby
@@ -393,22 +2474,27 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
393
2474
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
394
2475
 
395
2476
 
2477
+ engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
2478
+
396
2479
 
397
2480
  begin
398
- #Retrieve a list of canned messages ordered by short_code
399
- result = api_instance.get_conversation_canned_messages
2481
+ #Insert a engagement
2482
+ result = api_instance.insert_conversation_engagement(engagement)
400
2483
  p result
401
2484
  rescue UltracartClient::ApiError => e
402
- puts "Exception when calling ConversationApi->get_conversation_canned_messages: #{e}"
2485
+ puts "Exception when calling ConversationApi->insert_conversation_engagement: #{e}"
403
2486
  end
404
2487
  ```
405
2488
 
406
2489
  ### Parameters
407
- This endpoint does not need any parameter.
2490
+
2491
+ Name | Type | Description | Notes
2492
+ ------------- | ------------- | ------------- | -------------
2493
+ **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
408
2494
 
409
2495
  ### Return type
410
2496
 
411
- [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
2497
+ [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
412
2498
 
413
2499
  ### Authorization
414
2500
 
@@ -421,12 +2507,12 @@ This endpoint does not need any parameter.
421
2507
 
422
2508
 
423
2509
 
424
- # **get_conversation_context**
425
- > ConversationWebchatContext get_conversation_context(conversation_uuid)
2510
+ # **insert_pbx_agent**
2511
+ > ConversationPbxAgentResponse insert_pbx_agent(pbx_agent)
426
2512
 
427
- Get a webchat conversation context
2513
+ Insert pbx agent
428
2514
 
429
- Get a webchat conversation context
2515
+ Insert a pbx agent
430
2516
 
431
2517
  ### Example
432
2518
  ```ruby
@@ -438,15 +2524,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
438
2524
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
439
2525
 
440
2526
 
441
- conversation_uuid = 'conversation_uuid_example' # String |
2527
+ pbx_agent = UltracartClient::ConversationPbxAgent.new # ConversationPbxAgent | Pbx Agent
442
2528
 
443
2529
 
444
2530
  begin
445
- #Get a webchat conversation context
446
- result = api_instance.get_conversation_context(conversation_uuid)
2531
+ #Insert pbx agent
2532
+ result = api_instance.insert_pbx_agent(pbx_agent)
447
2533
  p result
448
2534
  rescue UltracartClient::ApiError => e
449
- puts "Exception when calling ConversationApi->get_conversation_context: #{e}"
2535
+ puts "Exception when calling ConversationApi->insert_pbx_agent: #{e}"
450
2536
  end
451
2537
  ```
452
2538
 
@@ -454,11 +2540,11 @@ end
454
2540
 
455
2541
  Name | Type | Description | Notes
456
2542
  ------------- | ------------- | ------------- | -------------
457
- **conversation_uuid** | **String**| |
2543
+ **pbx_agent** | [**ConversationPbxAgent**](ConversationPbxAgent.md)| Pbx Agent |
458
2544
 
459
2545
  ### Return type
460
2546
 
461
- [**ConversationWebchatContext**](ConversationWebchatContext.md)
2547
+ [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
462
2548
 
463
2549
  ### Authorization
464
2550
 
@@ -471,12 +2557,12 @@ Name | Type | Description | Notes
471
2557
 
472
2558
 
473
2559
 
474
- # **get_conversation_department_member_list**
475
- > ConversationDepartmentMembersResponse get_conversation_department_member_list
2560
+ # **insert_pbx_audio**
2561
+ > ConversationPbxAudioResponse insert_pbx_audio(pbx_audio)
476
2562
 
477
- Retrieve a list of possible department members
2563
+ Insert pbx audio
478
2564
 
479
- Retrieve a list of possible department members
2565
+ Insert a pbx audio
480
2566
 
481
2567
  ### Example
482
2568
  ```ruby
@@ -488,22 +2574,27 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
488
2574
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
489
2575
 
490
2576
 
2577
+ pbx_audio = UltracartClient::ConversationPbxAudio.new # ConversationPbxAudio | Pbx Audio
2578
+
491
2579
 
492
2580
  begin
493
- #Retrieve a list of possible department members
494
- result = api_instance.get_conversation_department_member_list
2581
+ #Insert pbx audio
2582
+ result = api_instance.insert_pbx_audio(pbx_audio)
495
2583
  p result
496
2584
  rescue UltracartClient::ApiError => e
497
- puts "Exception when calling ConversationApi->get_conversation_department_member_list: #{e}"
2585
+ puts "Exception when calling ConversationApi->insert_pbx_audio: #{e}"
498
2586
  end
499
2587
  ```
500
2588
 
501
2589
  ### Parameters
502
- This endpoint does not need any parameter.
2590
+
2591
+ Name | Type | Description | Notes
2592
+ ------------- | ------------- | ------------- | -------------
2593
+ **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md)| Pbx Audio |
503
2594
 
504
2595
  ### Return type
505
2596
 
506
- [**ConversationDepartmentMembersResponse**](ConversationDepartmentMembersResponse.md)
2597
+ [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
507
2598
 
508
2599
  ### Authorization
509
2600
 
@@ -516,12 +2607,12 @@ This endpoint does not need any parameter.
516
2607
 
517
2608
 
518
2609
 
519
- # **get_conversation_departments**
520
- > ConversationDepartmentsResponse get_conversation_departments
2610
+ # **insert_pbx_menu**
2611
+ > ConversationPbxMenuResponse insert_pbx_menu(pbx_menu)
521
2612
 
522
- Retrieve a list of departments ordered by name
2613
+ Insert pbx menu
523
2614
 
524
- Retrieve a list of departments ordered by name
2615
+ Insert a pbx menu
525
2616
 
526
2617
  ### Example
527
2618
  ```ruby
@@ -533,22 +2624,27 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
533
2624
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
534
2625
 
535
2626
 
2627
+ pbx_menu = UltracartClient::ConversationPbxMenu.new # ConversationPbxMenu | Pbx Menu
2628
+
536
2629
 
537
2630
  begin
538
- #Retrieve a list of departments ordered by name
539
- result = api_instance.get_conversation_departments
2631
+ #Insert pbx menu
2632
+ result = api_instance.insert_pbx_menu(pbx_menu)
540
2633
  p result
541
2634
  rescue UltracartClient::ApiError => e
542
- puts "Exception when calling ConversationApi->get_conversation_departments: #{e}"
2635
+ puts "Exception when calling ConversationApi->insert_pbx_menu: #{e}"
543
2636
  end
544
2637
  ```
545
2638
 
546
2639
  ### Parameters
547
- This endpoint does not need any parameter.
2640
+
2641
+ Name | Type | Description | Notes
2642
+ ------------- | ------------- | ------------- | -------------
2643
+ **pbx_menu** | [**ConversationPbxMenu**](ConversationPbxMenu.md)| Pbx Menu |
548
2644
 
549
2645
  ### Return type
550
2646
 
551
- [**ConversationDepartmentsResponse**](ConversationDepartmentsResponse.md)
2647
+ [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
552
2648
 
553
2649
  ### Authorization
554
2650
 
@@ -561,12 +2657,12 @@ This endpoint does not need any parameter.
561
2657
 
562
2658
 
563
2659
 
564
- # **get_conversation_engagement**
565
- > ConversationEngagementResponse get_conversation_engagement(conversation_engagement_oid)
2660
+ # **insert_pbx_phone_number**
2661
+ > ConversationPbxPhoneNumberResponse insert_pbx_phone_number(pbx_phone_number)
566
2662
 
567
- Retrieve an engagement
2663
+ Insert pbx phoneNumber
568
2664
 
569
- Retrieve an engagement
2665
+ Insert a pbx phoneNumber
570
2666
 
571
2667
  ### Example
572
2668
  ```ruby
@@ -578,15 +2674,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
578
2674
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
579
2675
 
580
2676
 
581
- conversation_engagement_oid = 56 # Integer |
2677
+ pbx_phone_number = UltracartClient::ConversationPbxPhoneNumber.new # ConversationPbxPhoneNumber | Pbx PhoneNumber
582
2678
 
583
2679
 
584
2680
  begin
585
- #Retrieve an engagement
586
- result = api_instance.get_conversation_engagement(conversation_engagement_oid)
2681
+ #Insert pbx phoneNumber
2682
+ result = api_instance.insert_pbx_phone_number(pbx_phone_number)
587
2683
  p result
588
2684
  rescue UltracartClient::ApiError => e
589
- puts "Exception when calling ConversationApi->get_conversation_engagement: #{e}"
2685
+ puts "Exception when calling ConversationApi->insert_pbx_phone_number: #{e}"
590
2686
  end
591
2687
  ```
592
2688
 
@@ -594,11 +2690,11 @@ end
594
2690
 
595
2691
  Name | Type | Description | Notes
596
2692
  ------------- | ------------- | ------------- | -------------
597
- **conversation_engagement_oid** | **Integer**| |
2693
+ **pbx_phone_number** | [**ConversationPbxPhoneNumber**](ConversationPbxPhoneNumber.md)| Pbx PhoneNumber |
598
2694
 
599
2695
  ### Return type
600
2696
 
601
- [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
2697
+ [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
602
2698
 
603
2699
  ### Authorization
604
2700
 
@@ -611,12 +2707,12 @@ Name | Type | Description | Notes
611
2707
 
612
2708
 
613
2709
 
614
- # **get_conversation_engagements**
615
- > ConversationEngagementsResponse get_conversation_engagements
2710
+ # **insert_pbx_queue**
2711
+ > ConversationPbxQueueResponse insert_pbx_queue(pbx_queue)
616
2712
 
617
- Retrieve a list of engagements ordered by name
2713
+ Insert pbx queue
618
2714
 
619
- Retrieve a list of engagements ordered by name
2715
+ Insert a pbx queue
620
2716
 
621
2717
  ### Example
622
2718
  ```ruby
@@ -628,22 +2724,27 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
628
2724
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
629
2725
 
630
2726
 
2727
+ pbx_queue = UltracartClient::ConversationPbxQueue.new # ConversationPbxQueue | Pbx Queue
2728
+
631
2729
 
632
2730
  begin
633
- #Retrieve a list of engagements ordered by name
634
- result = api_instance.get_conversation_engagements
2731
+ #Insert pbx queue
2732
+ result = api_instance.insert_pbx_queue(pbx_queue)
635
2733
  p result
636
2734
  rescue UltracartClient::ApiError => e
637
- puts "Exception when calling ConversationApi->get_conversation_engagements: #{e}"
2735
+ puts "Exception when calling ConversationApi->insert_pbx_queue: #{e}"
638
2736
  end
639
2737
  ```
640
2738
 
641
2739
  ### Parameters
642
- This endpoint does not need any parameter.
2740
+
2741
+ Name | Type | Description | Notes
2742
+ ------------- | ------------- | ------------- | -------------
2743
+ **pbx_queue** | [**ConversationPbxQueue**](ConversationPbxQueue.md)| Pbx Queue |
643
2744
 
644
2745
  ### Return type
645
2746
 
646
- [**ConversationEngagementsResponse**](ConversationEngagementsResponse.md)
2747
+ [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
647
2748
 
648
2749
  ### Authorization
649
2750
 
@@ -656,12 +2757,12 @@ This endpoint does not need any parameter.
656
2757
 
657
2758
 
658
2759
 
659
- # **get_conversation_messages**
660
- > ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
2760
+ # **insert_pbx_time_based**
2761
+ > ConversationPbxTimeBasedResponse insert_pbx_time_based(pbx_time_based)
661
2762
 
662
- Retrieve conversation messages
2763
+ Insert pbx timeBased
663
2764
 
664
- Retrieve conversation messages since a particular time
2765
+ Insert a pbx timeBased
665
2766
 
666
2767
  ### Example
667
2768
  ```ruby
@@ -673,20 +2774,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
673
2774
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
674
2775
 
675
2776
 
676
- conversation_uuid = 'conversation_uuid_example' # String |
677
-
678
- since = 789 # Integer |
2777
+ pbx_time_based = UltracartClient::ConversationPbxTimeBased.new # ConversationPbxTimeBased | Pbx TimeBased
679
2778
 
680
- opts = {
681
- limit: 56 # Integer |
682
- }
683
2779
 
684
2780
  begin
685
- #Retrieve conversation messages
686
- result = api_instance.get_conversation_messages(conversation_uuid, since, opts)
2781
+ #Insert pbx timeBased
2782
+ result = api_instance.insert_pbx_time_based(pbx_time_based)
687
2783
  p result
688
2784
  rescue UltracartClient::ApiError => e
689
- puts "Exception when calling ConversationApi->get_conversation_messages: #{e}"
2785
+ puts "Exception when calling ConversationApi->insert_pbx_time_based: #{e}"
690
2786
  end
691
2787
  ```
692
2788
 
@@ -694,13 +2790,11 @@ end
694
2790
 
695
2791
  Name | Type | Description | Notes
696
2792
  ------------- | ------------- | ------------- | -------------
697
- **conversation_uuid** | **String**| |
698
- **since** | **Integer**| |
699
- **limit** | **Integer**| | [optional]
2793
+ **pbx_time_based** | [**ConversationPbxTimeBased**](ConversationPbxTimeBased.md)| Pbx TimeBased |
700
2794
 
701
2795
  ### Return type
702
2796
 
703
- [**ConversationMessagesResponse**](ConversationMessagesResponse.md)
2797
+ [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
704
2798
 
705
2799
  ### Authorization
706
2800
 
@@ -713,12 +2807,12 @@ Name | Type | Description | Notes
713
2807
 
714
2808
 
715
2809
 
716
- # **get_conversation_multimedia_upload_url**
717
- > ConversationMultimediaUploadUrlResponse get_conversation_multimedia_upload_url(extension)
2810
+ # **insert_pbx_time_range**
2811
+ > ConversationPbxTimeRangeResponse insert_pbx_time_range(pbx_time_range)
718
2812
 
719
- Get a presigned conversation multimedia upload URL
2813
+ Insert pbx timeRange
720
2814
 
721
- Get a presigned conversation multimedia upload URL
2815
+ Insert a pbx timeRange
722
2816
 
723
2817
  ### Example
724
2818
  ```ruby
@@ -730,15 +2824,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
730
2824
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
731
2825
 
732
2826
 
733
- extension = 'extension_example' # String |
2827
+ pbx_time_range = UltracartClient::ConversationPbxTimeRange.new # ConversationPbxTimeRange | Pbx TimeRange
734
2828
 
735
2829
 
736
2830
  begin
737
- #Get a presigned conversation multimedia upload URL
738
- result = api_instance.get_conversation_multimedia_upload_url(extension)
2831
+ #Insert pbx timeRange
2832
+ result = api_instance.insert_pbx_time_range(pbx_time_range)
739
2833
  p result
740
2834
  rescue UltracartClient::ApiError => e
741
- puts "Exception when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
2835
+ puts "Exception when calling ConversationApi->insert_pbx_time_range: #{e}"
742
2836
  end
743
2837
  ```
744
2838
 
@@ -746,11 +2840,11 @@ end
746
2840
 
747
2841
  Name | Type | Description | Notes
748
2842
  ------------- | ------------- | ------------- | -------------
749
- **extension** | **String**| |
2843
+ **pbx_time_range** | [**ConversationPbxTimeRange**](ConversationPbxTimeRange.md)| Pbx TimeRange |
750
2844
 
751
2845
  ### Return type
752
2846
 
753
- [**ConversationMultimediaUploadUrlResponse**](ConversationMultimediaUploadUrlResponse.md)
2847
+ [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
754
2848
 
755
2849
  ### Authorization
756
2850
 
@@ -763,12 +2857,12 @@ Name | Type | Description | Notes
763
2857
 
764
2858
 
765
2859
 
766
- # **get_conversation_permissions**
767
- > ConversationPermissionsResponse get_conversation_permissions
2860
+ # **insert_pbx_voicemail_mailbox**
2861
+ > ConversationPbxVoicemailMailboxResponse insert_pbx_voicemail_mailbox(pbx_voicemail_mailbox)
768
2862
 
769
- Retrieve conversation permissions
2863
+ Insert pbx voicemailMailbox
770
2864
 
771
- Retrieve conversation permissions
2865
+ Insert a pbx voicemailMailbox
772
2866
 
773
2867
  ### Example
774
2868
  ```ruby
@@ -780,22 +2874,27 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
780
2874
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
781
2875
 
782
2876
 
2877
+ pbx_voicemail_mailbox = UltracartClient::ConversationPbxVoicemailMailbox.new # ConversationPbxVoicemailMailbox | Pbx VoicemailMailbox
2878
+
783
2879
 
784
2880
  begin
785
- #Retrieve conversation permissions
786
- result = api_instance.get_conversation_permissions
2881
+ #Insert pbx voicemailMailbox
2882
+ result = api_instance.insert_pbx_voicemail_mailbox(pbx_voicemail_mailbox)
787
2883
  p result
788
2884
  rescue UltracartClient::ApiError => e
789
- puts "Exception when calling ConversationApi->get_conversation_permissions: #{e}"
2885
+ puts "Exception when calling ConversationApi->insert_pbx_voicemail_mailbox: #{e}"
790
2886
  end
791
2887
  ```
792
2888
 
793
2889
  ### Parameters
794
- This endpoint does not need any parameter.
2890
+
2891
+ Name | Type | Description | Notes
2892
+ ------------- | ------------- | ------------- | -------------
2893
+ **pbx_voicemail_mailbox** | [**ConversationPbxVoicemailMailbox**](ConversationPbxVoicemailMailbox.md)| Pbx VoicemailMailbox |
795
2894
 
796
2895
  ### Return type
797
2896
 
798
- [**ConversationPermissionsResponse**](ConversationPermissionsResponse.md)
2897
+ [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
799
2898
 
800
2899
  ### Authorization
801
2900
 
@@ -808,12 +2907,12 @@ This endpoint does not need any parameter.
808
2907
 
809
2908
 
810
2909
 
811
- # **get_conversation_webchat_queue_statuses**
812
- > ConversationWebchatQueueStatusesResponse get_conversation_webchat_queue_statuses
2910
+ # **join_conversation**
2911
+ > join_conversation(conversation_uuid, opts)
813
2912
 
814
- Retrieve a conversation webchat queue statuses
2913
+ Join a conversation
815
2914
 
816
- Retrieve a conversation webchat queue statuses including agent status and queue entries
2915
+ Join a conversation
817
2916
 
818
2917
  ### Example
819
2918
  ```ruby
@@ -825,22 +2924,30 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
825
2924
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
826
2925
 
827
2926
 
2927
+ conversation_uuid = 'conversation_uuid_example' # String |
2928
+
2929
+ opts = {
2930
+ join_request: UltracartClient::ConversationJoinRequest.new # ConversationJoinRequest | Join request
2931
+ }
828
2932
 
829
2933
  begin
830
- #Retrieve a conversation webchat queue statuses
831
- result = api_instance.get_conversation_webchat_queue_statuses
832
- p result
2934
+ #Join a conversation
2935
+ api_instance.join_conversation(conversation_uuid, opts)
833
2936
  rescue UltracartClient::ApiError => e
834
- puts "Exception when calling ConversationApi->get_conversation_webchat_queue_statuses: #{e}"
2937
+ puts "Exception when calling ConversationApi->join_conversation: #{e}"
835
2938
  end
836
2939
  ```
837
2940
 
838
2941
  ### Parameters
839
- This endpoint does not need any parameter.
2942
+
2943
+ Name | Type | Description | Notes
2944
+ ------------- | ------------- | ------------- | -------------
2945
+ **conversation_uuid** | **String**| |
2946
+ **join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md)| Join request | [optional]
840
2947
 
841
2948
  ### Return type
842
2949
 
843
- [**ConversationWebchatQueueStatusesResponse**](ConversationWebchatQueueStatusesResponse.md)
2950
+ nil (empty response body)
844
2951
 
845
2952
  ### Authorization
846
2953
 
@@ -853,12 +2960,12 @@ This endpoint does not need any parameter.
853
2960
 
854
2961
 
855
2962
 
856
- # **get_conversations**
857
- > ConversationsResponse get_conversations(opts)
2963
+ # **leave_conversation**
2964
+ > leave_conversation(conversation_uuid)
858
2965
 
859
- Retrieve a list of conversation summaries newest to oldest
2966
+ Leave a conversation
860
2967
 
861
- Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
2968
+ Leave a conversation
862
2969
 
863
2970
  ### Example
864
2971
  ```ruby
@@ -870,19 +2977,14 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
870
2977
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
871
2978
 
872
2979
 
873
- opts = {
874
- medium: 'medium_example', # String |
875
- before: 'before_example', # String |
876
- _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
877
- _offset: 0 # Integer | Pagination of the record set. Offset is a zero based index.
878
- }
2980
+ conversation_uuid = 'conversation_uuid_example' # String |
2981
+
879
2982
 
880
2983
  begin
881
- #Retrieve a list of conversation summaries newest to oldest
882
- result = api_instance.get_conversations(opts)
883
- p result
2984
+ #Leave a conversation
2985
+ api_instance.leave_conversation(conversation_uuid)
884
2986
  rescue UltracartClient::ApiError => e
885
- puts "Exception when calling ConversationApi->get_conversations: #{e}"
2987
+ puts "Exception when calling ConversationApi->leave_conversation: #{e}"
886
2988
  end
887
2989
  ```
888
2990
 
@@ -890,14 +2992,11 @@ end
890
2992
 
891
2993
  Name | Type | Description | Notes
892
2994
  ------------- | ------------- | ------------- | -------------
893
- **medium** | **String**| | [optional]
894
- **before** | **String**| | [optional]
895
- **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
896
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
2995
+ **conversation_uuid** | **String**| |
897
2996
 
898
2997
  ### Return type
899
2998
 
900
- [**ConversationsResponse**](ConversationsResponse.md)
2999
+ nil (empty response body)
901
3000
 
902
3001
  ### Authorization
903
3002
 
@@ -910,12 +3009,12 @@ Name | Type | Description | Notes
910
3009
 
911
3010
 
912
3011
 
913
- # **get_conversations_autocomplete**
914
- > ConversationAutocompleteResponse get_conversations_autocomplete(autocomplete_request)
3012
+ # **mark_read_conversation**
3013
+ > mark_read_conversation(conversation_uuid)
915
3014
 
916
- Retrieve a list of matching terms for a search field
3015
+ Mark a conversation as read
917
3016
 
918
- Retrieve a list of matching terms for a search field
3017
+ Mark a conversation as read
919
3018
 
920
3019
  ### Example
921
3020
  ```ruby
@@ -927,15 +3026,14 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
927
3026
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
928
3027
 
929
3028
 
930
- autocomplete_request = UltracartClient::ConversationAutocompleteRequest.new # ConversationAutocompleteRequest | Autocomplete Request
3029
+ conversation_uuid = 'conversation_uuid_example' # String |
931
3030
 
932
3031
 
933
3032
  begin
934
- #Retrieve a list of matching terms for a search field
935
- result = api_instance.get_conversations_autocomplete(autocomplete_request)
936
- p result
3033
+ #Mark a conversation as read
3034
+ api_instance.mark_read_conversation(conversation_uuid)
937
3035
  rescue UltracartClient::ApiError => e
938
- puts "Exception when calling ConversationApi->get_conversations_autocomplete: #{e}"
3036
+ puts "Exception when calling ConversationApi->mark_read_conversation: #{e}"
939
3037
  end
940
3038
  ```
941
3039
 
@@ -943,11 +3041,11 @@ end
943
3041
 
944
3042
  Name | Type | Description | Notes
945
3043
  ------------- | ------------- | ------------- | -------------
946
- **autocomplete_request** | [**ConversationAutocompleteRequest**](ConversationAutocompleteRequest.md)| Autocomplete Request |
3044
+ **conversation_uuid** | **String**| |
947
3045
 
948
3046
  ### Return type
949
3047
 
950
- [**ConversationAutocompleteResponse**](ConversationAutocompleteResponse.md)
3048
+ nil (empty response body)
951
3049
 
952
3050
  ### Authorization
953
3051
 
@@ -960,12 +3058,12 @@ Name | Type | Description | Notes
960
3058
 
961
3059
 
962
3060
 
963
- # **get_conversations_search**
964
- > ConversationSearchResponse get_conversations_search(search_request)
3061
+ # **search_conversation_canned_messages**
3062
+ > ConversationCannedMessagesResponse search_conversation_canned_messages(search_request)
965
3063
 
966
- Search conversations
3064
+ Search for canned messages by short_code
967
3065
 
968
- Search conversations
3066
+ Search for canned messages by short_code
969
3067
 
970
3068
  ### Example
971
3069
  ```ruby
@@ -977,15 +3075,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
977
3075
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
978
3076
 
979
3077
 
980
- search_request = UltracartClient::ConversationSearchRequest.new # ConversationSearchRequest | Search Request
3078
+ search_request = UltracartClient::ConversationCannedMessagesSearch.new # ConversationCannedMessagesSearch | Search request
981
3079
 
982
3080
 
983
3081
  begin
984
- #Search conversations
985
- result = api_instance.get_conversations_search(search_request)
3082
+ #Search for canned messages by short_code
3083
+ result = api_instance.search_conversation_canned_messages(search_request)
986
3084
  p result
987
3085
  rescue UltracartClient::ApiError => e
988
- puts "Exception when calling ConversationApi->get_conversations_search: #{e}"
3086
+ puts "Exception when calling ConversationApi->search_conversation_canned_messages: #{e}"
989
3087
  end
990
3088
  ```
991
3089
 
@@ -993,11 +3091,11 @@ end
993
3091
 
994
3092
  Name | Type | Description | Notes
995
3093
  ------------- | ------------- | ------------- | -------------
996
- **search_request** | [**ConversationSearchRequest**](ConversationSearchRequest.md)| Search Request |
3094
+ **search_request** | [**ConversationCannedMessagesSearch**](ConversationCannedMessagesSearch.md)| Search request |
997
3095
 
998
3096
  ### Return type
999
3097
 
1000
- [**ConversationSearchResponse**](ConversationSearchResponse.md)
3098
+ [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
1001
3099
 
1002
3100
  ### Authorization
1003
3101
 
@@ -1010,12 +3108,12 @@ Name | Type | Description | Notes
1010
3108
 
1011
3109
 
1012
3110
 
1013
- # **get_locations_for_engagement**
1014
- > ConversationLocationsResponse get_locations_for_engagement
3111
+ # **sms_unsubscribe_conversation**
3112
+ > sms_unsubscribe_conversation(conversation_uuid)
1015
3113
 
1016
- Get location data for engagement configuration
3114
+ Unsubscribe any SMS participants in this conversation
1017
3115
 
1018
- Get location data for engagement configuration
3116
+ Unsubscribe any SMS participants in this conversation
1019
3117
 
1020
3118
  ### Example
1021
3119
  ```ruby
@@ -1027,22 +3125,26 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1027
3125
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1028
3126
 
1029
3127
 
3128
+ conversation_uuid = 'conversation_uuid_example' # String |
3129
+
1030
3130
 
1031
3131
  begin
1032
- #Get location data for engagement configuration
1033
- result = api_instance.get_locations_for_engagement
1034
- p result
3132
+ #Unsubscribe any SMS participants in this conversation
3133
+ api_instance.sms_unsubscribe_conversation(conversation_uuid)
1035
3134
  rescue UltracartClient::ApiError => e
1036
- puts "Exception when calling ConversationApi->get_locations_for_engagement: #{e}"
3135
+ puts "Exception when calling ConversationApi->sms_unsubscribe_conversation: #{e}"
1037
3136
  end
1038
3137
  ```
1039
3138
 
1040
3139
  ### Parameters
1041
- This endpoint does not need any parameter.
3140
+
3141
+ Name | Type | Description | Notes
3142
+ ------------- | ------------- | ------------- | -------------
3143
+ **conversation_uuid** | **String**| |
1042
3144
 
1043
3145
  ### Return type
1044
3146
 
1045
- [**ConversationLocationsResponse**](ConversationLocationsResponse.md)
3147
+ nil (empty response body)
1046
3148
 
1047
3149
  ### Authorization
1048
3150
 
@@ -1055,12 +3157,12 @@ This endpoint does not need any parameter.
1055
3157
 
1056
3158
 
1057
3159
 
1058
- # **insert_conversation_canned_message**
1059
- > ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
3160
+ # **start_conversation**
3161
+ > ConversationStartResponse start_conversation(start_request)
1060
3162
 
1061
- Insert a canned message
3163
+ Start a conversation
1062
3164
 
1063
- Insert a canned message
3165
+ Start a new conversation
1064
3166
 
1065
3167
  ### Example
1066
3168
  ```ruby
@@ -1072,15 +3174,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1072
3174
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1073
3175
 
1074
3176
 
1075
- canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
3177
+ start_request = UltracartClient::ConversationStartRequest.new # ConversationStartRequest | Start request
1076
3178
 
1077
3179
 
1078
3180
  begin
1079
- #Insert a canned message
1080
- result = api_instance.insert_conversation_canned_message(canned_message)
3181
+ #Start a conversation
3182
+ result = api_instance.start_conversation(start_request)
1081
3183
  p result
1082
3184
  rescue UltracartClient::ApiError => e
1083
- puts "Exception when calling ConversationApi->insert_conversation_canned_message: #{e}"
3185
+ puts "Exception when calling ConversationApi->start_conversation: #{e}"
1084
3186
  end
1085
3187
  ```
1086
3188
 
@@ -1088,11 +3190,11 @@ end
1088
3190
 
1089
3191
  Name | Type | Description | Notes
1090
3192
  ------------- | ------------- | ------------- | -------------
1091
- **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
3193
+ **start_request** | [**ConversationStartRequest**](ConversationStartRequest.md)| Start request |
1092
3194
 
1093
3195
  ### Return type
1094
3196
 
1095
- [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
3197
+ [**ConversationStartResponse**](ConversationStartResponse.md)
1096
3198
 
1097
3199
  ### Authorization
1098
3200
 
@@ -1105,12 +3207,12 @@ Name | Type | Description | Notes
1105
3207
 
1106
3208
 
1107
3209
 
1108
- # **insert_conversation_department**
1109
- > ConversationDepartmentResponse insert_conversation_department(department)
3210
+ # **update_agent_profile**
3211
+ > ConversationAgentProfileResponse update_agent_profile(profile_request)
1110
3212
 
1111
- Insert a department
3213
+ Update agent profile
1112
3214
 
1113
- Insert a department
3215
+ Update agent profile
1114
3216
 
1115
3217
  ### Example
1116
3218
  ```ruby
@@ -1122,15 +3224,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1122
3224
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1123
3225
 
1124
3226
 
1125
- department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
3227
+ profile_request = UltracartClient::ConversationAgentProfile.new # ConversationAgentProfile | Profile request
1126
3228
 
1127
3229
 
1128
3230
  begin
1129
- #Insert a department
1130
- result = api_instance.insert_conversation_department(department)
3231
+ #Update agent profile
3232
+ result = api_instance.update_agent_profile(profile_request)
1131
3233
  p result
1132
3234
  rescue UltracartClient::ApiError => e
1133
- puts "Exception when calling ConversationApi->insert_conversation_department: #{e}"
3235
+ puts "Exception when calling ConversationApi->update_agent_profile: #{e}"
1134
3236
  end
1135
3237
  ```
1136
3238
 
@@ -1138,11 +3240,11 @@ end
1138
3240
 
1139
3241
  Name | Type | Description | Notes
1140
3242
  ------------- | ------------- | ------------- | -------------
1141
- **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
3243
+ **profile_request** | [**ConversationAgentProfile**](ConversationAgentProfile.md)| Profile request |
1142
3244
 
1143
3245
  ### Return type
1144
3246
 
1145
- [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
3247
+ [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
1146
3248
 
1147
3249
  ### Authorization
1148
3250
 
@@ -1155,12 +3257,12 @@ Name | Type | Description | Notes
1155
3257
 
1156
3258
 
1157
3259
 
1158
- # **insert_conversation_engagement**
1159
- > ConversationEngagementResponse insert_conversation_engagement(engagement)
3260
+ # **update_conversation_canned_message**
3261
+ > ConversationCannedMessageResponse update_conversation_canned_message(conversation_canned_message_oid, canned_message)
1160
3262
 
1161
- Insert a engagement
3263
+ Update a canned message
1162
3264
 
1163
- Insert a engagement
3265
+ Update a canned message
1164
3266
 
1165
3267
  ### Example
1166
3268
  ```ruby
@@ -1172,15 +3274,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1172
3274
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1173
3275
 
1174
3276
 
1175
- engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
3277
+ conversation_canned_message_oid = 56 # Integer |
3278
+
3279
+ canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
1176
3280
 
1177
3281
 
1178
3282
  begin
1179
- #Insert a engagement
1180
- result = api_instance.insert_conversation_engagement(engagement)
3283
+ #Update a canned message
3284
+ result = api_instance.update_conversation_canned_message(conversation_canned_message_oid, canned_message)
1181
3285
  p result
1182
3286
  rescue UltracartClient::ApiError => e
1183
- puts "Exception when calling ConversationApi->insert_conversation_engagement: #{e}"
3287
+ puts "Exception when calling ConversationApi->update_conversation_canned_message: #{e}"
1184
3288
  end
1185
3289
  ```
1186
3290
 
@@ -1188,11 +3292,12 @@ end
1188
3292
 
1189
3293
  Name | Type | Description | Notes
1190
3294
  ------------- | ------------- | ------------- | -------------
1191
- **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
3295
+ **conversation_canned_message_oid** | **Integer**| |
3296
+ **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
1192
3297
 
1193
3298
  ### Return type
1194
3299
 
1195
- [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
3300
+ [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
1196
3301
 
1197
3302
  ### Authorization
1198
3303
 
@@ -1205,12 +3310,12 @@ Name | Type | Description | Notes
1205
3310
 
1206
3311
 
1207
3312
 
1208
- # **join_conversation**
1209
- > join_conversation(conversation_uuid, opts)
3313
+ # **update_conversation_department**
3314
+ > ConversationDepartmentResponse update_conversation_department(conversation_department_oid, department)
1210
3315
 
1211
- Join a conversation
3316
+ Update a department
1212
3317
 
1213
- Join a conversation
3318
+ Update a department
1214
3319
 
1215
3320
  ### Example
1216
3321
  ```ruby
@@ -1222,17 +3327,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1222
3327
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1223
3328
 
1224
3329
 
1225
- conversation_uuid = 'conversation_uuid_example' # String |
3330
+ conversation_department_oid = 56 # Integer |
3331
+
3332
+ department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
1226
3333
 
1227
- opts = {
1228
- join_request: UltracartClient::ConversationJoinRequest.new # ConversationJoinRequest | Join request
1229
- }
1230
3334
 
1231
3335
  begin
1232
- #Join a conversation
1233
- api_instance.join_conversation(conversation_uuid, opts)
3336
+ #Update a department
3337
+ result = api_instance.update_conversation_department(conversation_department_oid, department)
3338
+ p result
1234
3339
  rescue UltracartClient::ApiError => e
1235
- puts "Exception when calling ConversationApi->join_conversation: #{e}"
3340
+ puts "Exception when calling ConversationApi->update_conversation_department: #{e}"
1236
3341
  end
1237
3342
  ```
1238
3343
 
@@ -1240,12 +3345,12 @@ end
1240
3345
 
1241
3346
  Name | Type | Description | Notes
1242
3347
  ------------- | ------------- | ------------- | -------------
1243
- **conversation_uuid** | **String**| |
1244
- **join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md)| Join request | [optional]
3348
+ **conversation_department_oid** | **Integer**| |
3349
+ **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
1245
3350
 
1246
3351
  ### Return type
1247
3352
 
1248
- nil (empty response body)
3353
+ [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
1249
3354
 
1250
3355
  ### Authorization
1251
3356
 
@@ -1258,12 +3363,12 @@ nil (empty response body)
1258
3363
 
1259
3364
 
1260
3365
 
1261
- # **leave_conversation**
1262
- > leave_conversation(conversation_uuid)
3366
+ # **update_conversation_engagement**
3367
+ > ConversationEngagementResponse update_conversation_engagement(conversation_engagement_oid, engagement)
1263
3368
 
1264
- Leave a conversation
3369
+ Update a engagement
1265
3370
 
1266
- Leave a conversation
3371
+ Update a engagement
1267
3372
 
1268
3373
  ### Example
1269
3374
  ```ruby
@@ -1275,14 +3380,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1275
3380
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1276
3381
 
1277
3382
 
1278
- conversation_uuid = 'conversation_uuid_example' # String |
3383
+ conversation_engagement_oid = 56 # Integer |
3384
+
3385
+ engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
1279
3386
 
1280
3387
 
1281
3388
  begin
1282
- #Leave a conversation
1283
- api_instance.leave_conversation(conversation_uuid)
3389
+ #Update a engagement
3390
+ result = api_instance.update_conversation_engagement(conversation_engagement_oid, engagement)
3391
+ p result
1284
3392
  rescue UltracartClient::ApiError => e
1285
- puts "Exception when calling ConversationApi->leave_conversation: #{e}"
3393
+ puts "Exception when calling ConversationApi->update_conversation_engagement: #{e}"
1286
3394
  end
1287
3395
  ```
1288
3396
 
@@ -1290,11 +3398,12 @@ end
1290
3398
 
1291
3399
  Name | Type | Description | Notes
1292
3400
  ------------- | ------------- | ------------- | -------------
1293
- **conversation_uuid** | **String**| |
3401
+ **conversation_engagement_oid** | **Integer**| |
3402
+ **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
1294
3403
 
1295
3404
  ### Return type
1296
3405
 
1297
- nil (empty response body)
3406
+ [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
1298
3407
 
1299
3408
  ### Authorization
1300
3409
 
@@ -1307,12 +3416,12 @@ nil (empty response body)
1307
3416
 
1308
3417
 
1309
3418
 
1310
- # **mark_read_conversation**
1311
- > mark_read_conversation(conversation_uuid)
3419
+ # **update_conversation_webchat_queue_status**
3420
+ > update_conversation_webchat_queue_status(queue_name, status_request)
1312
3421
 
1313
- Mark a conversation as read
3422
+ Update status within the queue
1314
3423
 
1315
- Mark a conversation as read
3424
+ Update status within the queue
1316
3425
 
1317
3426
  ### Example
1318
3427
  ```ruby
@@ -1324,14 +3433,16 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1324
3433
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1325
3434
 
1326
3435
 
1327
- conversation_uuid = 'conversation_uuid_example' # String |
3436
+ queue_name = 'queue_name_example' # String |
3437
+
3438
+ status_request = UltracartClient::ConversationWebchatQueueStatusUpdateRequest.new # ConversationWebchatQueueStatusUpdateRequest | Status request
1328
3439
 
1329
3440
 
1330
3441
  begin
1331
- #Mark a conversation as read
1332
- api_instance.mark_read_conversation(conversation_uuid)
3442
+ #Update status within the queue
3443
+ api_instance.update_conversation_webchat_queue_status(queue_name, status_request)
1333
3444
  rescue UltracartClient::ApiError => e
1334
- puts "Exception when calling ConversationApi->mark_read_conversation: #{e}"
3445
+ puts "Exception when calling ConversationApi->update_conversation_webchat_queue_status: #{e}"
1335
3446
  end
1336
3447
  ```
1337
3448
 
@@ -1339,7 +3450,8 @@ end
1339
3450
 
1340
3451
  Name | Type | Description | Notes
1341
3452
  ------------- | ------------- | ------------- | -------------
1342
- **conversation_uuid** | **String**| |
3453
+ **queue_name** | **String**| |
3454
+ **status_request** | [**ConversationWebchatQueueStatusUpdateRequest**](ConversationWebchatQueueStatusUpdateRequest.md)| Status request |
1343
3455
 
1344
3456
  ### Return type
1345
3457
 
@@ -1356,12 +3468,12 @@ nil (empty response body)
1356
3468
 
1357
3469
 
1358
3470
 
1359
- # **search_conversation_canned_messages**
1360
- > ConversationCannedMessagesResponse search_conversation_canned_messages(search_request)
3471
+ # **update_pbx_agent**
3472
+ > ConversationPbxAgentResponse update_pbx_agent(conversation_pbx_agent_uuid, pbx_agent)
1361
3473
 
1362
- Search for canned messages by short_code
3474
+ Update pbx agent
1363
3475
 
1364
- Search for canned messages by short_code
3476
+ Update a pbx agent
1365
3477
 
1366
3478
  ### Example
1367
3479
  ```ruby
@@ -1373,15 +3485,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1373
3485
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1374
3486
 
1375
3487
 
1376
- search_request = UltracartClient::ConversationCannedMessagesSearch.new # ConversationCannedMessagesSearch | Search request
3488
+ conversation_pbx_agent_uuid = 'conversation_pbx_agent_uuid_example' # String |
3489
+
3490
+ pbx_agent = UltracartClient::ConversationPbxAgent.new # ConversationPbxAgent | Pbx Agent
1377
3491
 
1378
3492
 
1379
3493
  begin
1380
- #Search for canned messages by short_code
1381
- result = api_instance.search_conversation_canned_messages(search_request)
3494
+ #Update pbx agent
3495
+ result = api_instance.update_pbx_agent(conversation_pbx_agent_uuid, pbx_agent)
1382
3496
  p result
1383
3497
  rescue UltracartClient::ApiError => e
1384
- puts "Exception when calling ConversationApi->search_conversation_canned_messages: #{e}"
3498
+ puts "Exception when calling ConversationApi->update_pbx_agent: #{e}"
1385
3499
  end
1386
3500
  ```
1387
3501
 
@@ -1389,11 +3503,12 @@ end
1389
3503
 
1390
3504
  Name | Type | Description | Notes
1391
3505
  ------------- | ------------- | ------------- | -------------
1392
- **search_request** | [**ConversationCannedMessagesSearch**](ConversationCannedMessagesSearch.md)| Search request |
3506
+ **conversation_pbx_agent_uuid** | **String**| |
3507
+ **pbx_agent** | [**ConversationPbxAgent**](ConversationPbxAgent.md)| Pbx Agent |
1393
3508
 
1394
3509
  ### Return type
1395
3510
 
1396
- [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
3511
+ [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
1397
3512
 
1398
3513
  ### Authorization
1399
3514
 
@@ -1406,12 +3521,12 @@ Name | Type | Description | Notes
1406
3521
 
1407
3522
 
1408
3523
 
1409
- # **sms_unsubscribe_conversation**
1410
- > sms_unsubscribe_conversation(conversation_uuid)
3524
+ # **update_pbx_audio**
3525
+ > ConversationPbxAudioResponse update_pbx_audio(conversation_pbx_audio_uuid, pbx_audio)
1411
3526
 
1412
- Unsubscribe any SMS participants in this conversation
3527
+ Update pbx audio
1413
3528
 
1414
- Unsubscribe any SMS participants in this conversation
3529
+ Update a pbx audio
1415
3530
 
1416
3531
  ### Example
1417
3532
  ```ruby
@@ -1423,14 +3538,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1423
3538
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1424
3539
 
1425
3540
 
1426
- conversation_uuid = 'conversation_uuid_example' # String |
3541
+ conversation_pbx_audio_uuid = 'conversation_pbx_audio_uuid_example' # String |
3542
+
3543
+ pbx_audio = UltracartClient::ConversationPbxAudio.new # ConversationPbxAudio | Pbx Audio
1427
3544
 
1428
3545
 
1429
3546
  begin
1430
- #Unsubscribe any SMS participants in this conversation
1431
- api_instance.sms_unsubscribe_conversation(conversation_uuid)
3547
+ #Update pbx audio
3548
+ result = api_instance.update_pbx_audio(conversation_pbx_audio_uuid, pbx_audio)
3549
+ p result
1432
3550
  rescue UltracartClient::ApiError => e
1433
- puts "Exception when calling ConversationApi->sms_unsubscribe_conversation: #{e}"
3551
+ puts "Exception when calling ConversationApi->update_pbx_audio: #{e}"
1434
3552
  end
1435
3553
  ```
1436
3554
 
@@ -1438,11 +3556,12 @@ end
1438
3556
 
1439
3557
  Name | Type | Description | Notes
1440
3558
  ------------- | ------------- | ------------- | -------------
1441
- **conversation_uuid** | **String**| |
3559
+ **conversation_pbx_audio_uuid** | **String**| |
3560
+ **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md)| Pbx Audio |
1442
3561
 
1443
3562
  ### Return type
1444
3563
 
1445
- nil (empty response body)
3564
+ [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
1446
3565
 
1447
3566
  ### Authorization
1448
3567
 
@@ -1455,12 +3574,12 @@ nil (empty response body)
1455
3574
 
1456
3575
 
1457
3576
 
1458
- # **start_conversation**
1459
- > ConversationStartResponse start_conversation(start_request)
3577
+ # **update_pbx_menu**
3578
+ > ConversationPbxMenuResponse update_pbx_menu(conversation_pbx_menu_uuid, pbx_menu)
1460
3579
 
1461
- Start a conversation
3580
+ Update pbx menu
1462
3581
 
1463
- Start a new conversation
3582
+ Update a pbx menu
1464
3583
 
1465
3584
  ### Example
1466
3585
  ```ruby
@@ -1472,15 +3591,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1472
3591
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1473
3592
 
1474
3593
 
1475
- start_request = UltracartClient::ConversationStartRequest.new # ConversationStartRequest | Start request
3594
+ conversation_pbx_menu_uuid = 'conversation_pbx_menu_uuid_example' # String |
3595
+
3596
+ pbx_menu = UltracartClient::ConversationPbxMenu.new # ConversationPbxMenu | Pbx Menu
1476
3597
 
1477
3598
 
1478
3599
  begin
1479
- #Start a conversation
1480
- result = api_instance.start_conversation(start_request)
3600
+ #Update pbx menu
3601
+ result = api_instance.update_pbx_menu(conversation_pbx_menu_uuid, pbx_menu)
1481
3602
  p result
1482
3603
  rescue UltracartClient::ApiError => e
1483
- puts "Exception when calling ConversationApi->start_conversation: #{e}"
3604
+ puts "Exception when calling ConversationApi->update_pbx_menu: #{e}"
1484
3605
  end
1485
3606
  ```
1486
3607
 
@@ -1488,11 +3609,12 @@ end
1488
3609
 
1489
3610
  Name | Type | Description | Notes
1490
3611
  ------------- | ------------- | ------------- | -------------
1491
- **start_request** | [**ConversationStartRequest**](ConversationStartRequest.md)| Start request |
3612
+ **conversation_pbx_menu_uuid** | **String**| |
3613
+ **pbx_menu** | [**ConversationPbxMenu**](ConversationPbxMenu.md)| Pbx Menu |
1492
3614
 
1493
3615
  ### Return type
1494
3616
 
1495
- [**ConversationStartResponse**](ConversationStartResponse.md)
3617
+ [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
1496
3618
 
1497
3619
  ### Authorization
1498
3620
 
@@ -1505,12 +3627,12 @@ Name | Type | Description | Notes
1505
3627
 
1506
3628
 
1507
3629
 
1508
- # **update_agent_profile**
1509
- > ConversationAgentProfileResponse update_agent_profile(profile_request)
3630
+ # **update_pbx_phone_number**
3631
+ > ConversationPbxPhoneNumberResponse update_pbx_phone_number(conversation_pbx_phone_number_uuid, pbx_phone_number)
1510
3632
 
1511
- Update agent profile
3633
+ Update pbx phoneNumber
1512
3634
 
1513
- Update agent profile
3635
+ Update a pbx phoneNumber
1514
3636
 
1515
3637
  ### Example
1516
3638
  ```ruby
@@ -1522,15 +3644,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1522
3644
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1523
3645
 
1524
3646
 
1525
- profile_request = UltracartClient::ConversationAgentProfile.new # ConversationAgentProfile | Profile request
3647
+ conversation_pbx_phone_number_uuid = 'conversation_pbx_phone_number_uuid_example' # String |
3648
+
3649
+ pbx_phone_number = UltracartClient::ConversationPbxPhoneNumber.new # ConversationPbxPhoneNumber | Pbx PhoneNumber
1526
3650
 
1527
3651
 
1528
3652
  begin
1529
- #Update agent profile
1530
- result = api_instance.update_agent_profile(profile_request)
3653
+ #Update pbx phoneNumber
3654
+ result = api_instance.update_pbx_phone_number(conversation_pbx_phone_number_uuid, pbx_phone_number)
1531
3655
  p result
1532
3656
  rescue UltracartClient::ApiError => e
1533
- puts "Exception when calling ConversationApi->update_agent_profile: #{e}"
3657
+ puts "Exception when calling ConversationApi->update_pbx_phone_number: #{e}"
1534
3658
  end
1535
3659
  ```
1536
3660
 
@@ -1538,11 +3662,12 @@ end
1538
3662
 
1539
3663
  Name | Type | Description | Notes
1540
3664
  ------------- | ------------- | ------------- | -------------
1541
- **profile_request** | [**ConversationAgentProfile**](ConversationAgentProfile.md)| Profile request |
3665
+ **conversation_pbx_phone_number_uuid** | **String**| |
3666
+ **pbx_phone_number** | [**ConversationPbxPhoneNumber**](ConversationPbxPhoneNumber.md)| Pbx PhoneNumber |
1542
3667
 
1543
3668
  ### Return type
1544
3669
 
1545
- [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
3670
+ [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
1546
3671
 
1547
3672
  ### Authorization
1548
3673
 
@@ -1555,12 +3680,12 @@ Name | Type | Description | Notes
1555
3680
 
1556
3681
 
1557
3682
 
1558
- # **update_conversation_canned_message**
1559
- > ConversationCannedMessageResponse update_conversation_canned_message(conversation_canned_message_oid, canned_message)
3683
+ # **update_pbx_queue**
3684
+ > ConversationPbxQueueResponse update_pbx_queue(conversation_pbx_queue_uuid, pbx_queue)
1560
3685
 
1561
- Update a canned message
3686
+ Update pbx queue
1562
3687
 
1563
- Update a canned message
3688
+ Update a pbx queue
1564
3689
 
1565
3690
  ### Example
1566
3691
  ```ruby
@@ -1572,17 +3697,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1572
3697
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1573
3698
 
1574
3699
 
1575
- conversation_canned_message_oid = 56 # Integer |
3700
+ conversation_pbx_queue_uuid = 'conversation_pbx_queue_uuid_example' # String |
1576
3701
 
1577
- canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
3702
+ pbx_queue = UltracartClient::ConversationPbxQueue.new # ConversationPbxQueue | Pbx Queue
1578
3703
 
1579
3704
 
1580
3705
  begin
1581
- #Update a canned message
1582
- result = api_instance.update_conversation_canned_message(conversation_canned_message_oid, canned_message)
3706
+ #Update pbx queue
3707
+ result = api_instance.update_pbx_queue(conversation_pbx_queue_uuid, pbx_queue)
1583
3708
  p result
1584
3709
  rescue UltracartClient::ApiError => e
1585
- puts "Exception when calling ConversationApi->update_conversation_canned_message: #{e}"
3710
+ puts "Exception when calling ConversationApi->update_pbx_queue: #{e}"
1586
3711
  end
1587
3712
  ```
1588
3713
 
@@ -1590,12 +3715,12 @@ end
1590
3715
 
1591
3716
  Name | Type | Description | Notes
1592
3717
  ------------- | ------------- | ------------- | -------------
1593
- **conversation_canned_message_oid** | **Integer**| |
1594
- **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
3718
+ **conversation_pbx_queue_uuid** | **String**| |
3719
+ **pbx_queue** | [**ConversationPbxQueue**](ConversationPbxQueue.md)| Pbx Queue |
1595
3720
 
1596
3721
  ### Return type
1597
3722
 
1598
- [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
3723
+ [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
1599
3724
 
1600
3725
  ### Authorization
1601
3726
 
@@ -1608,12 +3733,12 @@ Name | Type | Description | Notes
1608
3733
 
1609
3734
 
1610
3735
 
1611
- # **update_conversation_department**
1612
- > ConversationDepartmentResponse update_conversation_department(conversation_department_oid, department)
3736
+ # **update_pbx_time_based**
3737
+ > ConversationPbxTimeBasedResponse update_pbx_time_based(conversation_pbx_time_based_uuid, pbx_time_based)
1613
3738
 
1614
- Update a department
3739
+ Update pbx timeBased
1615
3740
 
1616
- Update a department
3741
+ Update a pbx timeBased
1617
3742
 
1618
3743
  ### Example
1619
3744
  ```ruby
@@ -1625,17 +3750,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1625
3750
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1626
3751
 
1627
3752
 
1628
- conversation_department_oid = 56 # Integer |
3753
+ conversation_pbx_time_based_uuid = 'conversation_pbx_time_based_uuid_example' # String |
1629
3754
 
1630
- department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
3755
+ pbx_time_based = UltracartClient::ConversationPbxTimeBased.new # ConversationPbxTimeBased | Pbx TimeBased
1631
3756
 
1632
3757
 
1633
3758
  begin
1634
- #Update a department
1635
- result = api_instance.update_conversation_department(conversation_department_oid, department)
3759
+ #Update pbx timeBased
3760
+ result = api_instance.update_pbx_time_based(conversation_pbx_time_based_uuid, pbx_time_based)
1636
3761
  p result
1637
3762
  rescue UltracartClient::ApiError => e
1638
- puts "Exception when calling ConversationApi->update_conversation_department: #{e}"
3763
+ puts "Exception when calling ConversationApi->update_pbx_time_based: #{e}"
1639
3764
  end
1640
3765
  ```
1641
3766
 
@@ -1643,12 +3768,12 @@ end
1643
3768
 
1644
3769
  Name | Type | Description | Notes
1645
3770
  ------------- | ------------- | ------------- | -------------
1646
- **conversation_department_oid** | **Integer**| |
1647
- **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
3771
+ **conversation_pbx_time_based_uuid** | **String**| |
3772
+ **pbx_time_based** | [**ConversationPbxTimeBased**](ConversationPbxTimeBased.md)| Pbx TimeBased |
1648
3773
 
1649
3774
  ### Return type
1650
3775
 
1651
- [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
3776
+ [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
1652
3777
 
1653
3778
  ### Authorization
1654
3779
 
@@ -1661,12 +3786,12 @@ Name | Type | Description | Notes
1661
3786
 
1662
3787
 
1663
3788
 
1664
- # **update_conversation_engagement**
1665
- > ConversationEngagementResponse update_conversation_engagement(conversation_engagement_oid, engagement)
3789
+ # **update_pbx_time_range**
3790
+ > ConversationPbxTimeRangeResponse update_pbx_time_range(conversation_pbx_time_range_uuid, pbx_time_range)
1666
3791
 
1667
- Update a engagement
3792
+ Update pbx timeRange
1668
3793
 
1669
- Update a engagement
3794
+ Update a pbx timeRange
1670
3795
 
1671
3796
  ### Example
1672
3797
  ```ruby
@@ -1678,17 +3803,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1678
3803
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1679
3804
 
1680
3805
 
1681
- conversation_engagement_oid = 56 # Integer |
3806
+ conversation_pbx_time_range_uuid = 'conversation_pbx_time_range_uuid_example' # String |
1682
3807
 
1683
- engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
3808
+ pbx_time_range = UltracartClient::ConversationPbxTimeRange.new # ConversationPbxTimeRange | Pbx TimeRange
1684
3809
 
1685
3810
 
1686
3811
  begin
1687
- #Update a engagement
1688
- result = api_instance.update_conversation_engagement(conversation_engagement_oid, engagement)
3812
+ #Update pbx timeRange
3813
+ result = api_instance.update_pbx_time_range(conversation_pbx_time_range_uuid, pbx_time_range)
1689
3814
  p result
1690
3815
  rescue UltracartClient::ApiError => e
1691
- puts "Exception when calling ConversationApi->update_conversation_engagement: #{e}"
3816
+ puts "Exception when calling ConversationApi->update_pbx_time_range: #{e}"
1692
3817
  end
1693
3818
  ```
1694
3819
 
@@ -1696,12 +3821,12 @@ end
1696
3821
 
1697
3822
  Name | Type | Description | Notes
1698
3823
  ------------- | ------------- | ------------- | -------------
1699
- **conversation_engagement_oid** | **Integer**| |
1700
- **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
3824
+ **conversation_pbx_time_range_uuid** | **String**| |
3825
+ **pbx_time_range** | [**ConversationPbxTimeRange**](ConversationPbxTimeRange.md)| Pbx TimeRange |
1701
3826
 
1702
3827
  ### Return type
1703
3828
 
1704
- [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
3829
+ [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
1705
3830
 
1706
3831
  ### Authorization
1707
3832
 
@@ -1714,12 +3839,12 @@ Name | Type | Description | Notes
1714
3839
 
1715
3840
 
1716
3841
 
1717
- # **update_conversation_webchat_queue_status**
1718
- > update_conversation_webchat_queue_status(queue_name, status_request)
3842
+ # **update_pbx_voicemail_mailbox**
3843
+ > ConversationPbxVoicemailMailboxResponse update_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox)
1719
3844
 
1720
- Update status within the queue
3845
+ Update pbx voicemailMailbox
1721
3846
 
1722
- Update status within the queue
3847
+ Update a pbx voicemailMailbox
1723
3848
 
1724
3849
  ### Example
1725
3850
  ```ruby
@@ -1731,16 +3856,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1731
3856
  api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1732
3857
 
1733
3858
 
1734
- queue_name = 'queue_name_example' # String |
3859
+ conversation_pbx_voicemail_mailbox_uuid = 'conversation_pbx_voicemail_mailbox_uuid_example' # String |
1735
3860
 
1736
- status_request = UltracartClient::ConversationWebchatQueueStatusUpdateRequest.new # ConversationWebchatQueueStatusUpdateRequest | Status request
3861
+ pbx_voicemail_mailbox = UltracartClient::ConversationPbxVoicemailMailbox.new # ConversationPbxVoicemailMailbox | Pbx VoicemailMailbox
1737
3862
 
1738
3863
 
1739
3864
  begin
1740
- #Update status within the queue
1741
- api_instance.update_conversation_webchat_queue_status(queue_name, status_request)
3865
+ #Update pbx voicemailMailbox
3866
+ result = api_instance.update_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox)
3867
+ p result
1742
3868
  rescue UltracartClient::ApiError => e
1743
- puts "Exception when calling ConversationApi->update_conversation_webchat_queue_status: #{e}"
3869
+ puts "Exception when calling ConversationApi->update_pbx_voicemail_mailbox: #{e}"
1744
3870
  end
1745
3871
  ```
1746
3872
 
@@ -1748,12 +3874,12 @@ end
1748
3874
 
1749
3875
  Name | Type | Description | Notes
1750
3876
  ------------- | ------------- | ------------- | -------------
1751
- **queue_name** | **String**| |
1752
- **status_request** | [**ConversationWebchatQueueStatusUpdateRequest**](ConversationWebchatQueueStatusUpdateRequest.md)| Status request |
3877
+ **conversation_pbx_voicemail_mailbox_uuid** | **String**| |
3878
+ **pbx_voicemail_mailbox** | [**ConversationPbxVoicemailMailbox**](ConversationPbxVoicemailMailbox.md)| Pbx VoicemailMailbox |
1753
3879
 
1754
3880
  ### Return type
1755
3881
 
1756
- nil (empty response body)
3882
+ [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
1757
3883
 
1758
3884
  ### Authorization
1759
3885