ultracart_api 4.0.208 → 4.0.209
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +15 -4
- data/docs/AutoOrder.md +2 -0
- data/docs/AutoOrderItem.md +2 -0
- data/docs/ConversationApi.md +429 -0
- data/docs/ConversationPbxVoicemailMessage.md +42 -0
- data/docs/ConversationPbxVoicemailMessageResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +26 -0
- data/docs/ConversationPbxVoicemailMessageSummary.md +36 -0
- data/lib/ultracart_api/api/conversation_api.rb +384 -0
- data/lib/ultracart_api/models/auto_order.rb +11 -1
- data/lib/ultracart_api/models/auto_order_item.rb +11 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +29 -5
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +1 -1
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +374 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +344 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bf4bbb3e50d75d99e79d59263e08fdc9a5cafee1d534309493f2cbc06609552f
|
4
|
+
data.tar.gz: 16b085c366a7c16b643df24121e4eb3864209362e89a7e51d0d44f4b370c4280
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 628e84b3cf1a43303f8b7bfbc66a85c67f62335598e14751a1269c40c475eeacad2bb21a52a489b1acde82ea6cf0382e72ff2e653402a274a1ea44167d7ffb21
|
7
|
+
data.tar.gz: c1a629d28955e517201b4c715df4371c4be4ebc603494241576fcc5a5edf97a6b4b0425253685909e964e67429fce717de307e02552165f43908f36ea1418ca6
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.209
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.209.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.209.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.209'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -142,6 +142,7 @@ Class | Method | HTTP request | Description
|
|
142
142
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
143
143
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
144
144
|
*UltracartClient::ConversationApi* | [**delete_pbx_agent**](docs/ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent
|
145
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
|
145
146
|
*UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
|
146
147
|
*UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
|
147
148
|
*UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
|
@@ -170,6 +171,8 @@ Class | Method | HTTP request | Description
|
|
170
171
|
*UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
|
171
172
|
*UltracartClient::ConversationApi* | [**get_locations_for_engagement**](docs/ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
|
172
173
|
*UltracartClient::ConversationApi* | [**get_pbx_agent**](docs/ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
|
174
|
+
*UltracartClient::ConversationApi* | [**get_pbx_agent_voicemail**](docs/ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail
|
175
|
+
*UltracartClient::ConversationApi* | [**get_pbx_agent_voicemails**](docs/ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
|
173
176
|
*UltracartClient::ConversationApi* | [**get_pbx_agents**](docs/ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
|
174
177
|
*UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
|
175
178
|
*UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
|
@@ -178,6 +181,8 @@ Class | Method | HTTP request | Description
|
|
178
181
|
*UltracartClient::ConversationApi* | [**get_pbx_phone_number**](docs/ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
|
179
182
|
*UltracartClient::ConversationApi* | [**get_pbx_phone_numbers**](docs/ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
|
180
183
|
*UltracartClient::ConversationApi* | [**get_pbx_queue**](docs/ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
|
184
|
+
*UltracartClient::ConversationApi* | [**get_pbx_queue_voicemail**](docs/ConversationApi.md#get_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Get Queue Voicemail
|
185
|
+
*UltracartClient::ConversationApi* | [**get_pbx_queue_voicemails**](docs/ConversationApi.md#get_pbx_queue_voicemails) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails | Get Queue Voicemails
|
181
186
|
*UltracartClient::ConversationApi* | [**get_pbx_queues**](docs/ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues
|
182
187
|
*UltracartClient::ConversationApi* | [**get_pbx_time_based**](docs/ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased
|
183
188
|
*UltracartClient::ConversationApi* | [**get_pbx_time_baseds**](docs/ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
|
@@ -198,6 +203,7 @@ Class | Method | HTTP request | Description
|
|
198
203
|
*UltracartClient::ConversationApi* | [**insert_pbx_voicemail_mailbox**](docs/ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
|
199
204
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
200
205
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
206
|
+
*UltracartClient::ConversationApi* | [**listened_pbx_agent_voicemail**](docs/ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
|
201
207
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
202
208
|
*UltracartClient::ConversationApi* | [**reset_conversation_pbx_queue_statistics**](docs/ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
|
203
209
|
*UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
@@ -778,6 +784,10 @@ Class | Method | HTTP request | Description
|
|
778
784
|
- [UltracartClient::ConversationPbxVoicemailMailbox](docs/ConversationPbxVoicemailMailbox.md)
|
779
785
|
- [UltracartClient::ConversationPbxVoicemailMailboxResponse](docs/ConversationPbxVoicemailMailboxResponse.md)
|
780
786
|
- [UltracartClient::ConversationPbxVoicemailMailboxesResponse](docs/ConversationPbxVoicemailMailboxesResponse.md)
|
787
|
+
- [UltracartClient::ConversationPbxVoicemailMessage](docs/ConversationPbxVoicemailMessage.md)
|
788
|
+
- [UltracartClient::ConversationPbxVoicemailMessageResponse](docs/ConversationPbxVoicemailMessageResponse.md)
|
789
|
+
- [UltracartClient::ConversationPbxVoicemailMessageSummariesResponse](docs/ConversationPbxVoicemailMessageSummariesResponse.md)
|
790
|
+
- [UltracartClient::ConversationPbxVoicemailMessageSummary](docs/ConversationPbxVoicemailMessageSummary.md)
|
781
791
|
- [UltracartClient::ConversationPermissions](docs/ConversationPermissions.md)
|
782
792
|
- [UltracartClient::ConversationPermissionsResponse](docs/ConversationPermissionsResponse.md)
|
783
793
|
- [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
|
@@ -1494,6 +1504,7 @@ Not every change is committed to every SDK.
|
|
1494
1504
|
|
1495
1505
|
| Version | Date | Comments |
|
1496
1506
|
| --: | :-: | --- |
|
1507
|
+
| 4.0.209 | 04/01/2024 | added merchant_id as read-only top level property of AutoOrder object |
|
1497
1508
|
| 4.0.208 | 03/26/2024 | WorkflowTask - added assigned_to_user_or_group field |
|
1498
1509
|
| 4.0.207 | 03/25/2024 | workflowtask - add global_task_number and object_task_number |
|
1499
1510
|
| 4.0.206 | 03/25/2024 | added sales_rep_code to Channel partner order |
|
data/docs/AutoOrder.md
CHANGED
@@ -21,6 +21,7 @@
|
|
21
21
|
| **items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | The items that are setup to rebill | [optional] |
|
22
22
|
| **logs** | [**Array<AutoOrderLog>**](AutoOrderLog.md) | Logs associated with this auto order | [optional] |
|
23
23
|
| **management** | [**AutoOrderManagement**](AutoOrderManagement.md) | | [optional] |
|
24
|
+
| **merchant_id** | **String** | UltraCart merchant ID owning this order | [optional] |
|
24
25
|
| **next_attempt** | **String** | The next time that the auto order will be attempted for processing | [optional] |
|
25
26
|
| **original_order** | [**Order**](Order.md) | | [optional] |
|
26
27
|
| **original_order_id** | **String** | The original order id that this auto order is associated with. | [optional] |
|
@@ -52,6 +53,7 @@ instance = UltracartClient::AutoOrder.new(
|
|
52
53
|
items: null,
|
53
54
|
logs: null,
|
54
55
|
management: null,
|
56
|
+
merchant_id: null,
|
55
57
|
next_attempt: null,
|
56
58
|
original_order: null,
|
57
59
|
original_order_id: null,
|
data/docs/AutoOrderItem.md
CHANGED
@@ -16,6 +16,7 @@
|
|
16
16
|
| **future_schedules** | [**Array<AutoOrderItemFutureSchedule>**](AutoOrderItemFutureSchedule.md) | The future rebill schedule for this item up to the next ten rebills | [optional] |
|
17
17
|
| **last_order_dts** | **String** | Date/time of the last order of this item | [optional] |
|
18
18
|
| **life_time_value** | **Float** | The life time value of this item including the original purchase | [optional] |
|
19
|
+
| **next_item_id** | **String** | Calculated next item id | [optional] |
|
19
20
|
| **next_preshipment_notice_dts** | **String** | The date/time of when the next pre-shipment notice should be sent | [optional] |
|
20
21
|
| **next_shipment_dts** | **String** | Date/time that this item is scheduled to rebill | [optional] |
|
21
22
|
| **no_order_after_dts** | **String** | Date/time after which no additional rebills of this item should occur | [optional] |
|
@@ -49,6 +50,7 @@ instance = UltracartClient::AutoOrderItem.new(
|
|
49
50
|
future_schedules: null,
|
50
51
|
last_order_dts: null,
|
51
52
|
life_time_value: null,
|
53
|
+
next_item_id: null,
|
52
54
|
next_preshipment_notice_dts: null,
|
53
55
|
next_shipment_dts: null,
|
54
56
|
no_order_after_dts: null,
|
data/docs/ConversationApi.md
CHANGED
@@ -8,6 +8,7 @@ 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 |
|
@@ -36,6 +37,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
36
37
|
| [**get_conversations_search**](ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations |
|
37
38
|
| [**get_locations_for_engagement**](ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration |
|
38
39
|
| [**get_pbx_agent**](ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent |
|
40
|
+
| [**get_pbx_agent_voicemail**](ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail |
|
41
|
+
| [**get_pbx_agent_voicemails**](ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails |
|
39
42
|
| [**get_pbx_agents**](ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents |
|
40
43
|
| [**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio |
|
41
44
|
| [**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios |
|
@@ -44,6 +47,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
44
47
|
| [**get_pbx_phone_number**](ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber |
|
45
48
|
| [**get_pbx_phone_numbers**](ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers |
|
46
49
|
| [**get_pbx_queue**](ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue |
|
50
|
+
| [**get_pbx_queue_voicemail**](ConversationApi.md#get_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Get Queue Voicemail |
|
51
|
+
| [**get_pbx_queue_voicemails**](ConversationApi.md#get_pbx_queue_voicemails) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails | Get Queue Voicemails |
|
47
52
|
| [**get_pbx_queues**](ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues |
|
48
53
|
| [**get_pbx_time_based**](ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased |
|
49
54
|
| [**get_pbx_time_baseds**](ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds |
|
@@ -64,6 +69,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
64
69
|
| [**insert_pbx_voicemail_mailbox**](ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox |
|
65
70
|
| [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
|
66
71
|
| [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
|
72
|
+
| [**listened_pbx_agent_voicemail**](ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail |
|
67
73
|
| [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
|
68
74
|
| [**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
75
|
| [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
|
@@ -365,6 +371,76 @@ end
|
|
365
371
|
- **Accept**: application/json
|
366
372
|
|
367
373
|
|
374
|
+
## delete_pbx_agent_voicemail
|
375
|
+
|
376
|
+
> delete_pbx_agent_voicemail(recording_sid)
|
377
|
+
|
378
|
+
Delete Agent Voicemail
|
379
|
+
|
380
|
+
Delete pbx agent Voicemail
|
381
|
+
|
382
|
+
### Examples
|
383
|
+
|
384
|
+
```ruby
|
385
|
+
require 'time'
|
386
|
+
require 'ultracart_api'
|
387
|
+
require 'json'
|
388
|
+
require 'yaml'
|
389
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
390
|
+
|
391
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
392
|
+
# As such, this might not be the best way to use this object.
|
393
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
394
|
+
|
395
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
396
|
+
recording_sid = 'recording_sid_example' # String |
|
397
|
+
|
398
|
+
begin
|
399
|
+
# Delete Agent Voicemail
|
400
|
+
api_instance.delete_pbx_agent_voicemail(recording_sid)
|
401
|
+
rescue UltracartClient::ApiError => e
|
402
|
+
puts "Error when calling ConversationApi->delete_pbx_agent_voicemail: #{e}"
|
403
|
+
end
|
404
|
+
```
|
405
|
+
|
406
|
+
#### Using the delete_pbx_agent_voicemail_with_http_info variant
|
407
|
+
|
408
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
409
|
+
|
410
|
+
> <Array(nil, Integer, Hash)> delete_pbx_agent_voicemail_with_http_info(recording_sid)
|
411
|
+
|
412
|
+
```ruby
|
413
|
+
begin
|
414
|
+
# Delete Agent Voicemail
|
415
|
+
data, status_code, headers = api_instance.delete_pbx_agent_voicemail_with_http_info(recording_sid)
|
416
|
+
p status_code # => 2xx
|
417
|
+
p headers # => { ... }
|
418
|
+
p data # => nil
|
419
|
+
rescue UltracartClient::ApiError => e
|
420
|
+
puts "Error when calling ConversationApi->delete_pbx_agent_voicemail_with_http_info: #{e}"
|
421
|
+
end
|
422
|
+
```
|
423
|
+
|
424
|
+
### Parameters
|
425
|
+
|
426
|
+
| Name | Type | Description | Notes |
|
427
|
+
| ---- | ---- | ----------- | ----- |
|
428
|
+
| **recording_sid** | **String** | | |
|
429
|
+
|
430
|
+
### Return type
|
431
|
+
|
432
|
+
nil (empty response body)
|
433
|
+
|
434
|
+
### Authorization
|
435
|
+
|
436
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
437
|
+
|
438
|
+
### HTTP request headers
|
439
|
+
|
440
|
+
- **Content-Type**: Not defined
|
441
|
+
- **Accept**: application/json
|
442
|
+
|
443
|
+
|
368
444
|
## delete_pbx_audio
|
369
445
|
|
370
446
|
> <ConversationPbxAudioResponse> delete_pbx_audio(conversation_pbx_audio_uuid)
|
@@ -2340,6 +2416,145 @@ end
|
|
2340
2416
|
- **Accept**: application/json
|
2341
2417
|
|
2342
2418
|
|
2419
|
+
## get_pbx_agent_voicemail
|
2420
|
+
|
2421
|
+
> <ConversationPbxVoicemailMessageResponse> get_pbx_agent_voicemail(recording_sid)
|
2422
|
+
|
2423
|
+
Get Agent Voicemail
|
2424
|
+
|
2425
|
+
Retrieve pbx agent Voicemail
|
2426
|
+
|
2427
|
+
### Examples
|
2428
|
+
|
2429
|
+
```ruby
|
2430
|
+
require 'time'
|
2431
|
+
require 'ultracart_api'
|
2432
|
+
require 'json'
|
2433
|
+
require 'yaml'
|
2434
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
2435
|
+
|
2436
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
2437
|
+
# As such, this might not be the best way to use this object.
|
2438
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
2439
|
+
|
2440
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
2441
|
+
recording_sid = 'recording_sid_example' # String |
|
2442
|
+
|
2443
|
+
begin
|
2444
|
+
# Get Agent Voicemail
|
2445
|
+
result = api_instance.get_pbx_agent_voicemail(recording_sid)
|
2446
|
+
p result
|
2447
|
+
rescue UltracartClient::ApiError => e
|
2448
|
+
puts "Error when calling ConversationApi->get_pbx_agent_voicemail: #{e}"
|
2449
|
+
end
|
2450
|
+
```
|
2451
|
+
|
2452
|
+
#### Using the get_pbx_agent_voicemail_with_http_info variant
|
2453
|
+
|
2454
|
+
This returns an Array which contains the response data, status code and headers.
|
2455
|
+
|
2456
|
+
> <Array(<ConversationPbxVoicemailMessageResponse>, Integer, Hash)> get_pbx_agent_voicemail_with_http_info(recording_sid)
|
2457
|
+
|
2458
|
+
```ruby
|
2459
|
+
begin
|
2460
|
+
# Get Agent Voicemail
|
2461
|
+
data, status_code, headers = api_instance.get_pbx_agent_voicemail_with_http_info(recording_sid)
|
2462
|
+
p status_code # => 2xx
|
2463
|
+
p headers # => { ... }
|
2464
|
+
p data # => <ConversationPbxVoicemailMessageResponse>
|
2465
|
+
rescue UltracartClient::ApiError => e
|
2466
|
+
puts "Error when calling ConversationApi->get_pbx_agent_voicemail_with_http_info: #{e}"
|
2467
|
+
end
|
2468
|
+
```
|
2469
|
+
|
2470
|
+
### Parameters
|
2471
|
+
|
2472
|
+
| Name | Type | Description | Notes |
|
2473
|
+
| ---- | ---- | ----------- | ----- |
|
2474
|
+
| **recording_sid** | **String** | | |
|
2475
|
+
|
2476
|
+
### Return type
|
2477
|
+
|
2478
|
+
[**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
|
2479
|
+
|
2480
|
+
### Authorization
|
2481
|
+
|
2482
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2483
|
+
|
2484
|
+
### HTTP request headers
|
2485
|
+
|
2486
|
+
- **Content-Type**: Not defined
|
2487
|
+
- **Accept**: application/json
|
2488
|
+
|
2489
|
+
|
2490
|
+
## get_pbx_agent_voicemails
|
2491
|
+
|
2492
|
+
> <ConversationPbxVoicemailMessageSummariesResponse> get_pbx_agent_voicemails
|
2493
|
+
|
2494
|
+
Get Agent Voicemails
|
2495
|
+
|
2496
|
+
Retrieve pbx agent Voicemails
|
2497
|
+
|
2498
|
+
### Examples
|
2499
|
+
|
2500
|
+
```ruby
|
2501
|
+
require 'time'
|
2502
|
+
require 'ultracart_api'
|
2503
|
+
require 'json'
|
2504
|
+
require 'yaml'
|
2505
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
2506
|
+
|
2507
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
2508
|
+
# As such, this might not be the best way to use this object.
|
2509
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
2510
|
+
|
2511
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
2512
|
+
|
2513
|
+
begin
|
2514
|
+
# Get Agent Voicemails
|
2515
|
+
result = api_instance.get_pbx_agent_voicemails
|
2516
|
+
p result
|
2517
|
+
rescue UltracartClient::ApiError => e
|
2518
|
+
puts "Error when calling ConversationApi->get_pbx_agent_voicemails: #{e}"
|
2519
|
+
end
|
2520
|
+
```
|
2521
|
+
|
2522
|
+
#### Using the get_pbx_agent_voicemails_with_http_info variant
|
2523
|
+
|
2524
|
+
This returns an Array which contains the response data, status code and headers.
|
2525
|
+
|
2526
|
+
> <Array(<ConversationPbxVoicemailMessageSummariesResponse>, Integer, Hash)> get_pbx_agent_voicemails_with_http_info
|
2527
|
+
|
2528
|
+
```ruby
|
2529
|
+
begin
|
2530
|
+
# Get Agent Voicemails
|
2531
|
+
data, status_code, headers = api_instance.get_pbx_agent_voicemails_with_http_info
|
2532
|
+
p status_code # => 2xx
|
2533
|
+
p headers # => { ... }
|
2534
|
+
p data # => <ConversationPbxVoicemailMessageSummariesResponse>
|
2535
|
+
rescue UltracartClient::ApiError => e
|
2536
|
+
puts "Error when calling ConversationApi->get_pbx_agent_voicemails_with_http_info: #{e}"
|
2537
|
+
end
|
2538
|
+
```
|
2539
|
+
|
2540
|
+
### Parameters
|
2541
|
+
|
2542
|
+
This endpoint does not need any parameter.
|
2543
|
+
|
2544
|
+
### Return type
|
2545
|
+
|
2546
|
+
[**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
|
2547
|
+
|
2548
|
+
### Authorization
|
2549
|
+
|
2550
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2551
|
+
|
2552
|
+
### HTTP request headers
|
2553
|
+
|
2554
|
+
- **Content-Type**: Not defined
|
2555
|
+
- **Accept**: application/json
|
2556
|
+
|
2557
|
+
|
2343
2558
|
## get_pbx_agents
|
2344
2559
|
|
2345
2560
|
> <ConversationPbxAgentsResponse> get_pbx_agents
|
@@ -2896,6 +3111,150 @@ end
|
|
2896
3111
|
- **Accept**: application/json
|
2897
3112
|
|
2898
3113
|
|
3114
|
+
## get_pbx_queue_voicemail
|
3115
|
+
|
3116
|
+
> <ConversationPbxVoicemailMessageResponse> get_pbx_queue_voicemail(queue_uuid, recording_sid)
|
3117
|
+
|
3118
|
+
Get Queue Voicemail
|
3119
|
+
|
3120
|
+
Retrieve pbx queue Voicemail
|
3121
|
+
|
3122
|
+
### Examples
|
3123
|
+
|
3124
|
+
```ruby
|
3125
|
+
require 'time'
|
3126
|
+
require 'ultracart_api'
|
3127
|
+
require 'json'
|
3128
|
+
require 'yaml'
|
3129
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
3130
|
+
|
3131
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
3132
|
+
# As such, this might not be the best way to use this object.
|
3133
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
3134
|
+
|
3135
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
3136
|
+
queue_uuid = 'queue_uuid_example' # String |
|
3137
|
+
recording_sid = 'recording_sid_example' # String |
|
3138
|
+
|
3139
|
+
begin
|
3140
|
+
# Get Queue Voicemail
|
3141
|
+
result = api_instance.get_pbx_queue_voicemail(queue_uuid, recording_sid)
|
3142
|
+
p result
|
3143
|
+
rescue UltracartClient::ApiError => e
|
3144
|
+
puts "Error when calling ConversationApi->get_pbx_queue_voicemail: #{e}"
|
3145
|
+
end
|
3146
|
+
```
|
3147
|
+
|
3148
|
+
#### Using the get_pbx_queue_voicemail_with_http_info variant
|
3149
|
+
|
3150
|
+
This returns an Array which contains the response data, status code and headers.
|
3151
|
+
|
3152
|
+
> <Array(<ConversationPbxVoicemailMessageResponse>, Integer, Hash)> get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
|
3153
|
+
|
3154
|
+
```ruby
|
3155
|
+
begin
|
3156
|
+
# Get Queue Voicemail
|
3157
|
+
data, status_code, headers = api_instance.get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid)
|
3158
|
+
p status_code # => 2xx
|
3159
|
+
p headers # => { ... }
|
3160
|
+
p data # => <ConversationPbxVoicemailMessageResponse>
|
3161
|
+
rescue UltracartClient::ApiError => e
|
3162
|
+
puts "Error when calling ConversationApi->get_pbx_queue_voicemail_with_http_info: #{e}"
|
3163
|
+
end
|
3164
|
+
```
|
3165
|
+
|
3166
|
+
### Parameters
|
3167
|
+
|
3168
|
+
| Name | Type | Description | Notes |
|
3169
|
+
| ---- | ---- | ----------- | ----- |
|
3170
|
+
| **queue_uuid** | **String** | | |
|
3171
|
+
| **recording_sid** | **String** | | |
|
3172
|
+
|
3173
|
+
### Return type
|
3174
|
+
|
3175
|
+
[**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
|
3176
|
+
|
3177
|
+
### Authorization
|
3178
|
+
|
3179
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3180
|
+
|
3181
|
+
### HTTP request headers
|
3182
|
+
|
3183
|
+
- **Content-Type**: Not defined
|
3184
|
+
- **Accept**: application/json
|
3185
|
+
|
3186
|
+
|
3187
|
+
## get_pbx_queue_voicemails
|
3188
|
+
|
3189
|
+
> <ConversationPbxVoicemailMessageSummariesResponse> get_pbx_queue_voicemails(queue_uuid)
|
3190
|
+
|
3191
|
+
Get Queue Voicemails
|
3192
|
+
|
3193
|
+
Retrieve pbx queue voicemails
|
3194
|
+
|
3195
|
+
### Examples
|
3196
|
+
|
3197
|
+
```ruby
|
3198
|
+
require 'time'
|
3199
|
+
require 'ultracart_api'
|
3200
|
+
require 'json'
|
3201
|
+
require 'yaml'
|
3202
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
3203
|
+
|
3204
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
3205
|
+
# As such, this might not be the best way to use this object.
|
3206
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
3207
|
+
|
3208
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
3209
|
+
queue_uuid = 'queue_uuid_example' # String |
|
3210
|
+
|
3211
|
+
begin
|
3212
|
+
# Get Queue Voicemails
|
3213
|
+
result = api_instance.get_pbx_queue_voicemails(queue_uuid)
|
3214
|
+
p result
|
3215
|
+
rescue UltracartClient::ApiError => e
|
3216
|
+
puts "Error when calling ConversationApi->get_pbx_queue_voicemails: #{e}"
|
3217
|
+
end
|
3218
|
+
```
|
3219
|
+
|
3220
|
+
#### Using the get_pbx_queue_voicemails_with_http_info variant
|
3221
|
+
|
3222
|
+
This returns an Array which contains the response data, status code and headers.
|
3223
|
+
|
3224
|
+
> <Array(<ConversationPbxVoicemailMessageSummariesResponse>, Integer, Hash)> get_pbx_queue_voicemails_with_http_info(queue_uuid)
|
3225
|
+
|
3226
|
+
```ruby
|
3227
|
+
begin
|
3228
|
+
# Get Queue Voicemails
|
3229
|
+
data, status_code, headers = api_instance.get_pbx_queue_voicemails_with_http_info(queue_uuid)
|
3230
|
+
p status_code # => 2xx
|
3231
|
+
p headers # => { ... }
|
3232
|
+
p data # => <ConversationPbxVoicemailMessageSummariesResponse>
|
3233
|
+
rescue UltracartClient::ApiError => e
|
3234
|
+
puts "Error when calling ConversationApi->get_pbx_queue_voicemails_with_http_info: #{e}"
|
3235
|
+
end
|
3236
|
+
```
|
3237
|
+
|
3238
|
+
### Parameters
|
3239
|
+
|
3240
|
+
| Name | Type | Description | Notes |
|
3241
|
+
| ---- | ---- | ----------- | ----- |
|
3242
|
+
| **queue_uuid** | **String** | | |
|
3243
|
+
|
3244
|
+
### Return type
|
3245
|
+
|
3246
|
+
[**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
|
3247
|
+
|
3248
|
+
### Authorization
|
3249
|
+
|
3250
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3251
|
+
|
3252
|
+
### HTTP request headers
|
3253
|
+
|
3254
|
+
- **Content-Type**: Not defined
|
3255
|
+
- **Accept**: application/json
|
3256
|
+
|
3257
|
+
|
2899
3258
|
## get_pbx_queues
|
2900
3259
|
|
2901
3260
|
> <ConversationPbxQueuesResponse> get_pbx_queues
|
@@ -4306,6 +4665,76 @@ nil (empty response body)
|
|
4306
4665
|
- **Accept**: application/json
|
4307
4666
|
|
4308
4667
|
|
4668
|
+
## listened_pbx_agent_voicemail
|
4669
|
+
|
4670
|
+
> listened_pbx_agent_voicemail(recording_sid)
|
4671
|
+
|
4672
|
+
Listened Agent Voicemail
|
4673
|
+
|
4674
|
+
Listened pbx agent Voicemail
|
4675
|
+
|
4676
|
+
### Examples
|
4677
|
+
|
4678
|
+
```ruby
|
4679
|
+
require 'time'
|
4680
|
+
require 'ultracart_api'
|
4681
|
+
require 'json'
|
4682
|
+
require 'yaml'
|
4683
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
4684
|
+
|
4685
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
4686
|
+
# As such, this might not be the best way to use this object.
|
4687
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
4688
|
+
|
4689
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
4690
|
+
recording_sid = 'recording_sid_example' # String |
|
4691
|
+
|
4692
|
+
begin
|
4693
|
+
# Listened Agent Voicemail
|
4694
|
+
api_instance.listened_pbx_agent_voicemail(recording_sid)
|
4695
|
+
rescue UltracartClient::ApiError => e
|
4696
|
+
puts "Error when calling ConversationApi->listened_pbx_agent_voicemail: #{e}"
|
4697
|
+
end
|
4698
|
+
```
|
4699
|
+
|
4700
|
+
#### Using the listened_pbx_agent_voicemail_with_http_info variant
|
4701
|
+
|
4702
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
4703
|
+
|
4704
|
+
> <Array(nil, Integer, Hash)> listened_pbx_agent_voicemail_with_http_info(recording_sid)
|
4705
|
+
|
4706
|
+
```ruby
|
4707
|
+
begin
|
4708
|
+
# Listened Agent Voicemail
|
4709
|
+
data, status_code, headers = api_instance.listened_pbx_agent_voicemail_with_http_info(recording_sid)
|
4710
|
+
p status_code # => 2xx
|
4711
|
+
p headers # => { ... }
|
4712
|
+
p data # => nil
|
4713
|
+
rescue UltracartClient::ApiError => e
|
4714
|
+
puts "Error when calling ConversationApi->listened_pbx_agent_voicemail_with_http_info: #{e}"
|
4715
|
+
end
|
4716
|
+
```
|
4717
|
+
|
4718
|
+
### Parameters
|
4719
|
+
|
4720
|
+
| Name | Type | Description | Notes |
|
4721
|
+
| ---- | ---- | ----------- | ----- |
|
4722
|
+
| **recording_sid** | **String** | | |
|
4723
|
+
|
4724
|
+
### Return type
|
4725
|
+
|
4726
|
+
nil (empty response body)
|
4727
|
+
|
4728
|
+
### Authorization
|
4729
|
+
|
4730
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
4731
|
+
|
4732
|
+
### HTTP request headers
|
4733
|
+
|
4734
|
+
- **Content-Type**: Not defined
|
4735
|
+
- **Accept**: application/json
|
4736
|
+
|
4737
|
+
|
4309
4738
|
## mark_read_conversation
|
4310
4739
|
|
4311
4740
|
> 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
|
+
|