ultracart_api 4.0.208 → 4.0.210

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +19 -4
  3. data/docs/AutoOrder.md +2 -0
  4. data/docs/AutoOrderItem.md +4 -0
  5. data/docs/ConversationApi.md +575 -0
  6. data/docs/ConversationPbxVoicemailMessage.md +42 -0
  7. data/docs/ConversationPbxVoicemailMessageResponse.md +26 -0
  8. data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +26 -0
  9. data/docs/ConversationPbxVoicemailMessageSummary.md +36 -0
  10. data/docs/ItemApi.md +73 -0
  11. data/docs/WorkflowTask.md +2 -2
  12. data/docs/WorkflowTasksRequest.md +4 -0
  13. data/lib/ultracart_api/api/conversation_api.rb +524 -0
  14. data/lib/ultracart_api/api/item_api.rb +75 -0
  15. data/lib/ultracart_api/models/auto_order.rb +11 -1
  16. data/lib/ultracart_api/models/auto_order_item.rb +21 -1
  17. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +1 -1
  18. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +1 -1
  19. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +1 -1
  20. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +1 -1
  21. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +1 -1
  22. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +1 -1
  23. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +29 -5
  24. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +1 -1
  25. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +1 -1
  26. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +374 -0
  27. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +256 -0
  28. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +258 -0
  29. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +344 -0
  30. data/lib/ultracart_api/models/workflow_task.rb +2 -2
  31. data/lib/ultracart_api/models/workflow_tasks_request.rb +21 -1
  32. data/lib/ultracart_api/version.rb +1 -1
  33. data/lib/ultracart_api.rb +4 -0
  34. metadata +10 -2
@@ -8,10 +8,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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
10
  | [**delete_pbx_agent**](ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent |
11
+ | [**delete_pbx_agent_voicemail**](ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail |
11
12
  | [**delete_pbx_audio**](ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio |
12
13
  | [**delete_pbx_menu**](ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu |
13
14
  | [**delete_pbx_phone_number**](ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber |
14
15
  | [**delete_pbx_queue**](ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue |
16
+ | [**delete_pbx_queue_voicemail**](ConversationApi.md#delete_pbx_queue_voicemail) | **DELETE** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Delete Queue Voicemail |
15
17
  | [**delete_pbx_time_based**](ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased |
16
18
  | [**delete_pbx_time_range**](ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange |
17
19
  | [**delete_pbx_voicemail_mailbox**](ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox |
@@ -36,6 +38,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
36
38
  | [**get_conversations_search**](ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations |
37
39
  | [**get_locations_for_engagement**](ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration |
38
40
  | [**get_pbx_agent**](ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent |
41
+ | [**get_pbx_agent_voicemail**](ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail |
42
+ | [**get_pbx_agent_voicemails**](ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails |
39
43
  | [**get_pbx_agents**](ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents |
40
44
  | [**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio |
41
45
  | [**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios |
@@ -44,6 +48,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
44
48
  | [**get_pbx_phone_number**](ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber |
45
49
  | [**get_pbx_phone_numbers**](ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers |
46
50
  | [**get_pbx_queue**](ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue |
51
+ | [**get_pbx_queue_voicemail**](ConversationApi.md#get_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Get Queue Voicemail |
52
+ | [**get_pbx_queue_voicemails**](ConversationApi.md#get_pbx_queue_voicemails) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails | Get Queue Voicemails |
47
53
  | [**get_pbx_queues**](ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues |
48
54
  | [**get_pbx_time_based**](ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased |
49
55
  | [**get_pbx_time_baseds**](ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds |
@@ -64,6 +70,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
64
70
  | [**insert_pbx_voicemail_mailbox**](ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox |
65
71
  | [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
66
72
  | [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
73
+ | [**listened_pbx_agent_voicemail**](ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail |
74
+ | [**listened_pbx_queue_voicemail**](ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/{queue_uuid}/voicemails/voicemails/{recording_sid}/listened | Listened Queue Voicemail |
67
75
  | [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
68
76
  | [**reset_conversation_pbx_queue_statistics**](ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue |
69
77
  | [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
@@ -365,6 +373,76 @@ end
365
373
  - **Accept**: application/json
366
374
 
367
375
 
376
+ ## delete_pbx_agent_voicemail
377
+
378
+ > delete_pbx_agent_voicemail(recording_sid)
379
+
380
+ Delete Agent Voicemail
381
+
382
+ Delete pbx agent Voicemail
383
+
384
+ ### Examples
385
+
386
+ ```ruby
387
+ require 'time'
388
+ require 'ultracart_api'
389
+ require 'json'
390
+ require 'yaml'
391
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
392
+
393
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
394
+ # As such, this might not be the best way to use this object.
395
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
396
+
397
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
398
+ recording_sid = 'recording_sid_example' # String |
399
+
400
+ begin
401
+ # Delete Agent Voicemail
402
+ api_instance.delete_pbx_agent_voicemail(recording_sid)
403
+ rescue UltracartClient::ApiError => e
404
+ puts "Error when calling ConversationApi->delete_pbx_agent_voicemail: #{e}"
405
+ end
406
+ ```
407
+
408
+ #### Using the delete_pbx_agent_voicemail_with_http_info variant
409
+
410
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
411
+
412
+ > <Array(nil, Integer, Hash)> delete_pbx_agent_voicemail_with_http_info(recording_sid)
413
+
414
+ ```ruby
415
+ begin
416
+ # Delete Agent Voicemail
417
+ data, status_code, headers = api_instance.delete_pbx_agent_voicemail_with_http_info(recording_sid)
418
+ p status_code # => 2xx
419
+ p headers # => { ... }
420
+ p data # => nil
421
+ rescue UltracartClient::ApiError => e
422
+ puts "Error when calling ConversationApi->delete_pbx_agent_voicemail_with_http_info: #{e}"
423
+ end
424
+ ```
425
+
426
+ ### Parameters
427
+
428
+ | Name | Type | Description | Notes |
429
+ | ---- | ---- | ----------- | ----- |
430
+ | **recording_sid** | **String** | | |
431
+
432
+ ### Return type
433
+
434
+ nil (empty response body)
435
+
436
+ ### Authorization
437
+
438
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
439
+
440
+ ### HTTP request headers
441
+
442
+ - **Content-Type**: Not defined
443
+ - **Accept**: application/json
444
+
445
+
368
446
  ## delete_pbx_audio
369
447
 
370
448
  > <ConversationPbxAudioResponse> delete_pbx_audio(conversation_pbx_audio_uuid)
@@ -649,6 +727,78 @@ end
649
727
  - **Accept**: application/json
650
728
 
651
729
 
730
+ ## delete_pbx_queue_voicemail
731
+
732
+ > delete_pbx_queue_voicemail(queue_uuid, recording_sid)
733
+
734
+ Delete Queue Voicemail
735
+
736
+ Delete pbx queue Voicemail
737
+
738
+ ### Examples
739
+
740
+ ```ruby
741
+ require 'time'
742
+ require 'ultracart_api'
743
+ require 'json'
744
+ require 'yaml'
745
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
746
+
747
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
748
+ # As such, this might not be the best way to use this object.
749
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
750
+
751
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
752
+ queue_uuid = 'queue_uuid_example' # String |
753
+ recording_sid = 'recording_sid_example' # String |
754
+
755
+ begin
756
+ # Delete Queue Voicemail
757
+ api_instance.delete_pbx_queue_voicemail(queue_uuid, recording_sid)
758
+ rescue UltracartClient::ApiError => e
759
+ puts "Error when calling ConversationApi->delete_pbx_queue_voicemail: #{e}"
760
+ end
761
+ ```
762
+
763
+ #### Using the delete_pbx_queue_voicemail_with_http_info variant
764
+
765
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
766
+
767
+ > <Array(nil, Integer, Hash)> delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
768
+
769
+ ```ruby
770
+ begin
771
+ # Delete Queue Voicemail
772
+ data, status_code, headers = api_instance.delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
773
+ p status_code # => 2xx
774
+ p headers # => { ... }
775
+ p data # => nil
776
+ rescue UltracartClient::ApiError => e
777
+ puts "Error when calling ConversationApi->delete_pbx_queue_voicemail_with_http_info: #{e}"
778
+ end
779
+ ```
780
+
781
+ ### Parameters
782
+
783
+ | Name | Type | Description | Notes |
784
+ | ---- | ---- | ----------- | ----- |
785
+ | **queue_uuid** | **String** | | |
786
+ | **recording_sid** | **String** | | |
787
+
788
+ ### Return type
789
+
790
+ nil (empty response body)
791
+
792
+ ### Authorization
793
+
794
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
795
+
796
+ ### HTTP request headers
797
+
798
+ - **Content-Type**: Not defined
799
+ - **Accept**: application/json
800
+
801
+
652
802
  ## delete_pbx_time_based
653
803
 
654
804
  > <ConversationPbxTimeBasedResponse> delete_pbx_time_based(conversation_pbx_time_based_uuid)
@@ -2340,6 +2490,145 @@ end
2340
2490
  - **Accept**: application/json
2341
2491
 
2342
2492
 
2493
+ ## get_pbx_agent_voicemail
2494
+
2495
+ > <ConversationPbxVoicemailMessageResponse> get_pbx_agent_voicemail(recording_sid)
2496
+
2497
+ Get Agent Voicemail
2498
+
2499
+ Retrieve pbx agent Voicemail
2500
+
2501
+ ### Examples
2502
+
2503
+ ```ruby
2504
+ require 'time'
2505
+ require 'ultracart_api'
2506
+ require 'json'
2507
+ require 'yaml'
2508
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
2509
+
2510
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
2511
+ # As such, this might not be the best way to use this object.
2512
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
2513
+
2514
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
2515
+ recording_sid = 'recording_sid_example' # String |
2516
+
2517
+ begin
2518
+ # Get Agent Voicemail
2519
+ result = api_instance.get_pbx_agent_voicemail(recording_sid)
2520
+ p result
2521
+ rescue UltracartClient::ApiError => e
2522
+ puts "Error when calling ConversationApi->get_pbx_agent_voicemail: #{e}"
2523
+ end
2524
+ ```
2525
+
2526
+ #### Using the get_pbx_agent_voicemail_with_http_info variant
2527
+
2528
+ This returns an Array which contains the response data, status code and headers.
2529
+
2530
+ > <Array(<ConversationPbxVoicemailMessageResponse>, Integer, Hash)> get_pbx_agent_voicemail_with_http_info(recording_sid)
2531
+
2532
+ ```ruby
2533
+ begin
2534
+ # Get Agent Voicemail
2535
+ data, status_code, headers = api_instance.get_pbx_agent_voicemail_with_http_info(recording_sid)
2536
+ p status_code # => 2xx
2537
+ p headers # => { ... }
2538
+ p data # => <ConversationPbxVoicemailMessageResponse>
2539
+ rescue UltracartClient::ApiError => e
2540
+ puts "Error when calling ConversationApi->get_pbx_agent_voicemail_with_http_info: #{e}"
2541
+ end
2542
+ ```
2543
+
2544
+ ### Parameters
2545
+
2546
+ | Name | Type | Description | Notes |
2547
+ | ---- | ---- | ----------- | ----- |
2548
+ | **recording_sid** | **String** | | |
2549
+
2550
+ ### Return type
2551
+
2552
+ [**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
2553
+
2554
+ ### Authorization
2555
+
2556
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2557
+
2558
+ ### HTTP request headers
2559
+
2560
+ - **Content-Type**: Not defined
2561
+ - **Accept**: application/json
2562
+
2563
+
2564
+ ## get_pbx_agent_voicemails
2565
+
2566
+ > <ConversationPbxVoicemailMessageSummariesResponse> get_pbx_agent_voicemails
2567
+
2568
+ Get Agent Voicemails
2569
+
2570
+ Retrieve pbx agent Voicemails
2571
+
2572
+ ### Examples
2573
+
2574
+ ```ruby
2575
+ require 'time'
2576
+ require 'ultracart_api'
2577
+ require 'json'
2578
+ require 'yaml'
2579
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
2580
+
2581
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
2582
+ # As such, this might not be the best way to use this object.
2583
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
2584
+
2585
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
2586
+
2587
+ begin
2588
+ # Get Agent Voicemails
2589
+ result = api_instance.get_pbx_agent_voicemails
2590
+ p result
2591
+ rescue UltracartClient::ApiError => e
2592
+ puts "Error when calling ConversationApi->get_pbx_agent_voicemails: #{e}"
2593
+ end
2594
+ ```
2595
+
2596
+ #### Using the get_pbx_agent_voicemails_with_http_info variant
2597
+
2598
+ This returns an Array which contains the response data, status code and headers.
2599
+
2600
+ > <Array(<ConversationPbxVoicemailMessageSummariesResponse>, Integer, Hash)> get_pbx_agent_voicemails_with_http_info
2601
+
2602
+ ```ruby
2603
+ begin
2604
+ # Get Agent Voicemails
2605
+ data, status_code, headers = api_instance.get_pbx_agent_voicemails_with_http_info
2606
+ p status_code # => 2xx
2607
+ p headers # => { ... }
2608
+ p data # => <ConversationPbxVoicemailMessageSummariesResponse>
2609
+ rescue UltracartClient::ApiError => e
2610
+ puts "Error when calling ConversationApi->get_pbx_agent_voicemails_with_http_info: #{e}"
2611
+ end
2612
+ ```
2613
+
2614
+ ### Parameters
2615
+
2616
+ This endpoint does not need any parameter.
2617
+
2618
+ ### Return type
2619
+
2620
+ [**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
2621
+
2622
+ ### Authorization
2623
+
2624
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2625
+
2626
+ ### HTTP request headers
2627
+
2628
+ - **Content-Type**: Not defined
2629
+ - **Accept**: application/json
2630
+
2631
+
2343
2632
  ## get_pbx_agents
2344
2633
 
2345
2634
  > <ConversationPbxAgentsResponse> get_pbx_agents
@@ -2896,6 +3185,150 @@ end
2896
3185
  - **Accept**: application/json
2897
3186
 
2898
3187
 
3188
+ ## get_pbx_queue_voicemail
3189
+
3190
+ > <ConversationPbxVoicemailMessageResponse> get_pbx_queue_voicemail(queue_uuid, recording_sid)
3191
+
3192
+ Get Queue Voicemail
3193
+
3194
+ Retrieve pbx queue Voicemail
3195
+
3196
+ ### Examples
3197
+
3198
+ ```ruby
3199
+ require 'time'
3200
+ require 'ultracart_api'
3201
+ require 'json'
3202
+ require 'yaml'
3203
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
3204
+
3205
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
3206
+ # As such, this might not be the best way to use this object.
3207
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
3208
+
3209
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
3210
+ queue_uuid = 'queue_uuid_example' # String |
3211
+ recording_sid = 'recording_sid_example' # String |
3212
+
3213
+ begin
3214
+ # Get Queue Voicemail
3215
+ result = api_instance.get_pbx_queue_voicemail(queue_uuid, recording_sid)
3216
+ p result
3217
+ rescue UltracartClient::ApiError => e
3218
+ puts "Error when calling ConversationApi->get_pbx_queue_voicemail: #{e}"
3219
+ end
3220
+ ```
3221
+
3222
+ #### Using the get_pbx_queue_voicemail_with_http_info variant
3223
+
3224
+ This returns an Array which contains the response data, status code and headers.
3225
+
3226
+ > <Array(<ConversationPbxVoicemailMessageResponse>, Integer, Hash)> get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
3227
+
3228
+ ```ruby
3229
+ begin
3230
+ # Get Queue Voicemail
3231
+ data, status_code, headers = api_instance.get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
3232
+ p status_code # => 2xx
3233
+ p headers # => { ... }
3234
+ p data # => <ConversationPbxVoicemailMessageResponse>
3235
+ rescue UltracartClient::ApiError => e
3236
+ puts "Error when calling ConversationApi->get_pbx_queue_voicemail_with_http_info: #{e}"
3237
+ end
3238
+ ```
3239
+
3240
+ ### Parameters
3241
+
3242
+ | Name | Type | Description | Notes |
3243
+ | ---- | ---- | ----------- | ----- |
3244
+ | **queue_uuid** | **String** | | |
3245
+ | **recording_sid** | **String** | | |
3246
+
3247
+ ### Return type
3248
+
3249
+ [**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
3250
+
3251
+ ### Authorization
3252
+
3253
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3254
+
3255
+ ### HTTP request headers
3256
+
3257
+ - **Content-Type**: Not defined
3258
+ - **Accept**: application/json
3259
+
3260
+
3261
+ ## get_pbx_queue_voicemails
3262
+
3263
+ > <ConversationPbxVoicemailMessageSummariesResponse> get_pbx_queue_voicemails(queue_uuid)
3264
+
3265
+ Get Queue Voicemails
3266
+
3267
+ Retrieve pbx queue voicemails
3268
+
3269
+ ### Examples
3270
+
3271
+ ```ruby
3272
+ require 'time'
3273
+ require 'ultracart_api'
3274
+ require 'json'
3275
+ require 'yaml'
3276
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
3277
+
3278
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
3279
+ # As such, this might not be the best way to use this object.
3280
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
3281
+
3282
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
3283
+ queue_uuid = 'queue_uuid_example' # String |
3284
+
3285
+ begin
3286
+ # Get Queue Voicemails
3287
+ result = api_instance.get_pbx_queue_voicemails(queue_uuid)
3288
+ p result
3289
+ rescue UltracartClient::ApiError => e
3290
+ puts "Error when calling ConversationApi->get_pbx_queue_voicemails: #{e}"
3291
+ end
3292
+ ```
3293
+
3294
+ #### Using the get_pbx_queue_voicemails_with_http_info variant
3295
+
3296
+ This returns an Array which contains the response data, status code and headers.
3297
+
3298
+ > <Array(<ConversationPbxVoicemailMessageSummariesResponse>, Integer, Hash)> get_pbx_queue_voicemails_with_http_info(queue_uuid)
3299
+
3300
+ ```ruby
3301
+ begin
3302
+ # Get Queue Voicemails
3303
+ data, status_code, headers = api_instance.get_pbx_queue_voicemails_with_http_info(queue_uuid)
3304
+ p status_code # => 2xx
3305
+ p headers # => { ... }
3306
+ p data # => <ConversationPbxVoicemailMessageSummariesResponse>
3307
+ rescue UltracartClient::ApiError => e
3308
+ puts "Error when calling ConversationApi->get_pbx_queue_voicemails_with_http_info: #{e}"
3309
+ end
3310
+ ```
3311
+
3312
+ ### Parameters
3313
+
3314
+ | Name | Type | Description | Notes |
3315
+ | ---- | ---- | ----------- | ----- |
3316
+ | **queue_uuid** | **String** | | |
3317
+
3318
+ ### Return type
3319
+
3320
+ [**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
3321
+
3322
+ ### Authorization
3323
+
3324
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3325
+
3326
+ ### HTTP request headers
3327
+
3328
+ - **Content-Type**: Not defined
3329
+ - **Accept**: application/json
3330
+
3331
+
2899
3332
  ## get_pbx_queues
2900
3333
 
2901
3334
  > <ConversationPbxQueuesResponse> get_pbx_queues
@@ -4306,6 +4739,148 @@ nil (empty response body)
4306
4739
  - **Accept**: application/json
4307
4740
 
4308
4741
 
4742
+ ## listened_pbx_agent_voicemail
4743
+
4744
+ > listened_pbx_agent_voicemail(recording_sid)
4745
+
4746
+ Listened Agent Voicemail
4747
+
4748
+ Listened pbx agent Voicemail
4749
+
4750
+ ### Examples
4751
+
4752
+ ```ruby
4753
+ require 'time'
4754
+ require 'ultracart_api'
4755
+ require 'json'
4756
+ require 'yaml'
4757
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
4758
+
4759
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
4760
+ # As such, this might not be the best way to use this object.
4761
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
4762
+
4763
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
4764
+ recording_sid = 'recording_sid_example' # String |
4765
+
4766
+ begin
4767
+ # Listened Agent Voicemail
4768
+ api_instance.listened_pbx_agent_voicemail(recording_sid)
4769
+ rescue UltracartClient::ApiError => e
4770
+ puts "Error when calling ConversationApi->listened_pbx_agent_voicemail: #{e}"
4771
+ end
4772
+ ```
4773
+
4774
+ #### Using the listened_pbx_agent_voicemail_with_http_info variant
4775
+
4776
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
4777
+
4778
+ > <Array(nil, Integer, Hash)> listened_pbx_agent_voicemail_with_http_info(recording_sid)
4779
+
4780
+ ```ruby
4781
+ begin
4782
+ # Listened Agent Voicemail
4783
+ data, status_code, headers = api_instance.listened_pbx_agent_voicemail_with_http_info(recording_sid)
4784
+ p status_code # => 2xx
4785
+ p headers # => { ... }
4786
+ p data # => nil
4787
+ rescue UltracartClient::ApiError => e
4788
+ puts "Error when calling ConversationApi->listened_pbx_agent_voicemail_with_http_info: #{e}"
4789
+ end
4790
+ ```
4791
+
4792
+ ### Parameters
4793
+
4794
+ | Name | Type | Description | Notes |
4795
+ | ---- | ---- | ----------- | ----- |
4796
+ | **recording_sid** | **String** | | |
4797
+
4798
+ ### Return type
4799
+
4800
+ nil (empty response body)
4801
+
4802
+ ### Authorization
4803
+
4804
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4805
+
4806
+ ### HTTP request headers
4807
+
4808
+ - **Content-Type**: Not defined
4809
+ - **Accept**: application/json
4810
+
4811
+
4812
+ ## listened_pbx_queue_voicemail
4813
+
4814
+ > listened_pbx_queue_voicemail(queue_uuid, recording_sid)
4815
+
4816
+ Listened Queue Voicemail
4817
+
4818
+ Listened pbx queue Voicemail
4819
+
4820
+ ### Examples
4821
+
4822
+ ```ruby
4823
+ require 'time'
4824
+ require 'ultracart_api'
4825
+ require 'json'
4826
+ require 'yaml'
4827
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
4828
+
4829
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
4830
+ # As such, this might not be the best way to use this object.
4831
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
4832
+
4833
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
4834
+ queue_uuid = 'queue_uuid_example' # String |
4835
+ recording_sid = 'recording_sid_example' # String |
4836
+
4837
+ begin
4838
+ # Listened Queue Voicemail
4839
+ api_instance.listened_pbx_queue_voicemail(queue_uuid, recording_sid)
4840
+ rescue UltracartClient::ApiError => e
4841
+ puts "Error when calling ConversationApi->listened_pbx_queue_voicemail: #{e}"
4842
+ end
4843
+ ```
4844
+
4845
+ #### Using the listened_pbx_queue_voicemail_with_http_info variant
4846
+
4847
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
4848
+
4849
+ > <Array(nil, Integer, Hash)> listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
4850
+
4851
+ ```ruby
4852
+ begin
4853
+ # Listened Queue Voicemail
4854
+ data, status_code, headers = api_instance.listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
4855
+ p status_code # => 2xx
4856
+ p headers # => { ... }
4857
+ p data # => nil
4858
+ rescue UltracartClient::ApiError => e
4859
+ puts "Error when calling ConversationApi->listened_pbx_queue_voicemail_with_http_info: #{e}"
4860
+ end
4861
+ ```
4862
+
4863
+ ### Parameters
4864
+
4865
+ | Name | Type | Description | Notes |
4866
+ | ---- | ---- | ----------- | ----- |
4867
+ | **queue_uuid** | **String** | | |
4868
+ | **recording_sid** | **String** | | |
4869
+
4870
+ ### Return type
4871
+
4872
+ nil (empty response body)
4873
+
4874
+ ### Authorization
4875
+
4876
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4877
+
4878
+ ### HTTP request headers
4879
+
4880
+ - **Content-Type**: Not defined
4881
+ - **Accept**: application/json
4882
+
4883
+
4309
4884
  ## mark_read_conversation
4310
4885
 
4311
4886
  > mark_read_conversation(conversation_uuid)
@@ -0,0 +1,42 @@
1
+ # UltracartClient::ConversationPbxVoicemailMessage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **call_sid** | **String** | Call SID | [optional] |
8
+ | **duration** | **Integer** | Duration in seconds | [optional] |
9
+ | **from** | **String** | From phone number in E.164 | [optional] |
10
+ | **from_caller_id** | **String** | From caller id (if available) | [optional] |
11
+ | **listened** | **Boolean** | True if the voicemail has been listened to in the user interface | [optional] |
12
+ | **merchant_id** | **String** | Merchant ID | [optional] |
13
+ | **recording_sid** | **String** | Recording SID | [optional] |
14
+ | **recording_size_bytes** | **Integer** | Recording size in bytes | [optional] |
15
+ | **recording_status** | **String** | Recording Status | [optional] |
16
+ | **recording_url** | **String** | Recording URL (expires in 4 hours) | [optional] |
17
+ | **transcript_json** | **String** | JSON version of the transcript | [optional] |
18
+ | **transcript_text** | **String** | Formatted text of the transcript | [optional] |
19
+ | **voicemail_dts** | **String** | Voicemail date/time | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'ultracart_api'
25
+
26
+ instance = UltracartClient::ConversationPbxVoicemailMessage.new(
27
+ call_sid: null,
28
+ duration: null,
29
+ from: null,
30
+ from_caller_id: null,
31
+ listened: null,
32
+ merchant_id: null,
33
+ recording_sid: null,
34
+ recording_size_bytes: null,
35
+ recording_status: null,
36
+ recording_url: null,
37
+ transcript_json: null,
38
+ transcript_text: null,
39
+ voicemail_dts: null
40
+ )
41
+ ```
42
+