ultracart_api 3.10.191 → 3.10.192
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.
- checksums.yaml +4 -4
- data/README.md +15 -4
- data/docs/AutoOrder.md +1 -0
- data/docs/AutoOrderItem.md +1 -0
- data/docs/ConversationApi.md +302 -0
- data/docs/ConversationPbxVoicemailMessage.md +20 -0
- data/docs/ConversationPbxVoicemailMessageResponse.md +12 -0
- data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +12 -0
- data/docs/ConversationPbxVoicemailMessageSummary.md +17 -0
- data/lib/ultracart_api/api/conversation_api.rb +328 -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 +3 -3
- data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +29 -5
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +3 -3
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +339 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +309 -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: d4de3cf40fdb033fe848abb8e7455cf9a8a4d72dbc289c7a23ae7c03044da09c
|
4
|
+
data.tar.gz: 5692acec6e3aec11b86df823d0b0f28ad4414329a36132ae9c27fc423eb3edd3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eb3464401fa736843e17eaaa24f22203bb2d3e68c9f36836fba082b256f9572e39f9ee503821b168cdc01f33655e2e000245e34f3608e8b9b0146939ca2c08a3
|
7
|
+
data.tar.gz: edbaa67d15e3bdc74b701898e5c5e807274687953e05cfe3796c079123653260c0a09d575f85186d5bfbe9e618e963258efe796632857bd5fd7e8b58202da6d7
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.192
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.192.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.192.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.192'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
|
|
136
136
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
137
137
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
138
138
|
*UltracartClient::ConversationApi* | [**delete_pbx_agent**](docs/ConversationApi.md#delete_pbx_agent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent
|
139
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
|
139
140
|
*UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
|
140
141
|
*UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
|
141
142
|
*UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
|
@@ -164,6 +165,8 @@ Class | Method | HTTP request | Description
|
|
164
165
|
*UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
|
165
166
|
*UltracartClient::ConversationApi* | [**get_locations_for_engagement**](docs/ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
|
166
167
|
*UltracartClient::ConversationApi* | [**get_pbx_agent**](docs/ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
|
168
|
+
*UltracartClient::ConversationApi* | [**get_pbx_agent_voicemail**](docs/ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail
|
169
|
+
*UltracartClient::ConversationApi* | [**get_pbx_agent_voicemails**](docs/ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
|
167
170
|
*UltracartClient::ConversationApi* | [**get_pbx_agents**](docs/ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
|
168
171
|
*UltracartClient::ConversationApi* | [**get_pbx_audio**](docs/ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
|
169
172
|
*UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
|
@@ -172,6 +175,8 @@ Class | Method | HTTP request | Description
|
|
172
175
|
*UltracartClient::ConversationApi* | [**get_pbx_phone_number**](docs/ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
|
173
176
|
*UltracartClient::ConversationApi* | [**get_pbx_phone_numbers**](docs/ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
|
174
177
|
*UltracartClient::ConversationApi* | [**get_pbx_queue**](docs/ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
|
178
|
+
*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
|
179
|
+
*UltracartClient::ConversationApi* | [**get_pbx_queue_voicemails**](docs/ConversationApi.md#get_pbx_queue_voicemails) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails | Get Queue Voicemails
|
175
180
|
*UltracartClient::ConversationApi* | [**get_pbx_queues**](docs/ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues
|
176
181
|
*UltracartClient::ConversationApi* | [**get_pbx_time_based**](docs/ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased
|
177
182
|
*UltracartClient::ConversationApi* | [**get_pbx_time_baseds**](docs/ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
|
@@ -192,6 +197,7 @@ Class | Method | HTTP request | Description
|
|
192
197
|
*UltracartClient::ConversationApi* | [**insert_pbx_voicemail_mailbox**](docs/ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
|
193
198
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
194
199
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
200
|
+
*UltracartClient::ConversationApi* | [**listened_pbx_agent_voicemail**](docs/ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
|
195
201
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
196
202
|
*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
|
197
203
|
*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
|
@@ -773,6 +779,10 @@ Class | Method | HTTP request | Description
|
|
773
779
|
- [UltracartClient::ConversationPbxVoicemailMailbox](docs/ConversationPbxVoicemailMailbox.md)
|
774
780
|
- [UltracartClient::ConversationPbxVoicemailMailboxResponse](docs/ConversationPbxVoicemailMailboxResponse.md)
|
775
781
|
- [UltracartClient::ConversationPbxVoicemailMailboxesResponse](docs/ConversationPbxVoicemailMailboxesResponse.md)
|
782
|
+
- [UltracartClient::ConversationPbxVoicemailMessage](docs/ConversationPbxVoicemailMessage.md)
|
783
|
+
- [UltracartClient::ConversationPbxVoicemailMessageResponse](docs/ConversationPbxVoicemailMessageResponse.md)
|
784
|
+
- [UltracartClient::ConversationPbxVoicemailMessageSummariesResponse](docs/ConversationPbxVoicemailMessageSummariesResponse.md)
|
785
|
+
- [UltracartClient::ConversationPbxVoicemailMessageSummary](docs/ConversationPbxVoicemailMessageSummary.md)
|
776
786
|
- [UltracartClient::ConversationPermissions](docs/ConversationPermissions.md)
|
777
787
|
- [UltracartClient::ConversationPermissionsResponse](docs/ConversationPermissionsResponse.md)
|
778
788
|
- [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
|
@@ -1486,6 +1496,7 @@ Not every change is committed to every SDK.
|
|
1486
1496
|
|
1487
1497
|
| Version | Date | Comments |
|
1488
1498
|
| --: | :-: | --- |
|
1499
|
+
| 3.10.192 | 04/01/2024 | added merchant_id as read-only top level property of AutoOrder object |
|
1489
1500
|
| 3.10.191 | 03/26/2024 | WorkflowTask - added assigned_to_user_or_group field |
|
1490
1501
|
| 3.10.190 | 03/25/2024 | workflowtask - add global_task_number and object_task_number |
|
1491
1502
|
| 3.10.189 | 03/25/2024 | added sales_rep_code to Channel partner order |
|
data/docs/AutoOrder.md
CHANGED
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
|
20
20
|
**items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | The items that are setup to rebill | [optional]
|
21
21
|
**logs** | [**Array<AutoOrderLog>**](AutoOrderLog.md) | Logs associated with this auto order | [optional]
|
22
22
|
**management** | [**AutoOrderManagement**](AutoOrderManagement.md) | | [optional]
|
23
|
+
**merchant_id** | **String** | UltraCart merchant ID owning this order | [optional]
|
23
24
|
**next_attempt** | **String** | The next time that the auto order will be attempted for processing | [optional]
|
24
25
|
**original_order** | [**Order**](Order.md) | | [optional]
|
25
26
|
**original_order_id** | **String** | The original order id that this auto order is associated with. | [optional]
|
data/docs/AutoOrderItem.md
CHANGED
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|
15
15
|
**future_schedules** | [**Array<AutoOrderItemFutureSchedule>**](AutoOrderItemFutureSchedule.md) | The future rebill schedule for this item up to the next ten rebills | [optional]
|
16
16
|
**last_order_dts** | **String** | Date/time of the last order of this item | [optional]
|
17
17
|
**life_time_value** | **Float** | The life time value of this item including the original purchase | [optional]
|
18
|
+
**next_item_id** | **String** | Calculated next item id | [optional]
|
18
19
|
**next_preshipment_notice_dts** | **String** | The date/time of when the next pre-shipment notice should be sent | [optional]
|
19
20
|
**next_shipment_dts** | **String** | Date/time that this item is scheduled to rebill | [optional]
|
20
21
|
**no_order_after_dts** | **String** | Date/time after which no additional rebills of this item should occur | [optional]
|
data/docs/ConversationApi.md
CHANGED
@@ -8,6 +8,7 @@ Method | HTTP request | Description
|
|
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 @@ Method | HTTP request | Description
|
|
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 @@ Method | HTTP request | Description
|
|
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 @@ Method | HTTP request | Description
|
|
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
|
@@ -281,6 +287,55 @@ Name | Type | Description | Notes
|
|
281
287
|
|
282
288
|
|
283
289
|
|
290
|
+
# **delete_pbx_agent_voicemail**
|
291
|
+
> delete_pbx_agent_voicemail(recording_sid)
|
292
|
+
|
293
|
+
Delete Agent Voicemail
|
294
|
+
|
295
|
+
Delete pbx agent Voicemail
|
296
|
+
|
297
|
+
### Example
|
298
|
+
```ruby
|
299
|
+
# load the gem
|
300
|
+
require 'ultracart_api'
|
301
|
+
|
302
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
303
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
304
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
305
|
+
|
306
|
+
|
307
|
+
recording_sid = 'recording_sid_example' # String |
|
308
|
+
|
309
|
+
|
310
|
+
begin
|
311
|
+
#Delete Agent Voicemail
|
312
|
+
api_instance.delete_pbx_agent_voicemail(recording_sid)
|
313
|
+
rescue UltracartClient::ApiError => e
|
314
|
+
puts "Exception when calling ConversationApi->delete_pbx_agent_voicemail: #{e}"
|
315
|
+
end
|
316
|
+
```
|
317
|
+
|
318
|
+
### Parameters
|
319
|
+
|
320
|
+
Name | Type | Description | Notes
|
321
|
+
------------- | ------------- | ------------- | -------------
|
322
|
+
**recording_sid** | **String**| |
|
323
|
+
|
324
|
+
### Return type
|
325
|
+
|
326
|
+
nil (empty response body)
|
327
|
+
|
328
|
+
### Authorization
|
329
|
+
|
330
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
331
|
+
|
332
|
+
### HTTP request headers
|
333
|
+
|
334
|
+
- **Content-Type**: application/json
|
335
|
+
- **Accept**: application/json
|
336
|
+
|
337
|
+
|
338
|
+
|
284
339
|
# **delete_pbx_audio**
|
285
340
|
> ConversationPbxAudioResponse delete_pbx_audio(conversation_pbx_audio_uuid)
|
286
341
|
|
@@ -1648,6 +1703,101 @@ Name | Type | Description | Notes
|
|
1648
1703
|
|
1649
1704
|
|
1650
1705
|
|
1706
|
+
# **get_pbx_agent_voicemail**
|
1707
|
+
> ConversationPbxVoicemailMessageResponse get_pbx_agent_voicemail(recording_sid)
|
1708
|
+
|
1709
|
+
Get Agent Voicemail
|
1710
|
+
|
1711
|
+
Retrieve pbx agent Voicemail
|
1712
|
+
|
1713
|
+
### Example
|
1714
|
+
```ruby
|
1715
|
+
# load the gem
|
1716
|
+
require 'ultracart_api'
|
1717
|
+
|
1718
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1719
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1720
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
1721
|
+
|
1722
|
+
|
1723
|
+
recording_sid = 'recording_sid_example' # String |
|
1724
|
+
|
1725
|
+
|
1726
|
+
begin
|
1727
|
+
#Get Agent Voicemail
|
1728
|
+
result = api_instance.get_pbx_agent_voicemail(recording_sid)
|
1729
|
+
p result
|
1730
|
+
rescue UltracartClient::ApiError => e
|
1731
|
+
puts "Exception when calling ConversationApi->get_pbx_agent_voicemail: #{e}"
|
1732
|
+
end
|
1733
|
+
```
|
1734
|
+
|
1735
|
+
### Parameters
|
1736
|
+
|
1737
|
+
Name | Type | Description | Notes
|
1738
|
+
------------- | ------------- | ------------- | -------------
|
1739
|
+
**recording_sid** | **String**| |
|
1740
|
+
|
1741
|
+
### Return type
|
1742
|
+
|
1743
|
+
[**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
|
1744
|
+
|
1745
|
+
### Authorization
|
1746
|
+
|
1747
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1748
|
+
|
1749
|
+
### HTTP request headers
|
1750
|
+
|
1751
|
+
- **Content-Type**: application/json
|
1752
|
+
- **Accept**: application/json
|
1753
|
+
|
1754
|
+
|
1755
|
+
|
1756
|
+
# **get_pbx_agent_voicemails**
|
1757
|
+
> ConversationPbxVoicemailMessageSummariesResponse get_pbx_agent_voicemails
|
1758
|
+
|
1759
|
+
Get Agent Voicemails
|
1760
|
+
|
1761
|
+
Retrieve pbx agent Voicemails
|
1762
|
+
|
1763
|
+
### Example
|
1764
|
+
```ruby
|
1765
|
+
# load the gem
|
1766
|
+
require 'ultracart_api'
|
1767
|
+
|
1768
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1769
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1770
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
1771
|
+
|
1772
|
+
|
1773
|
+
|
1774
|
+
begin
|
1775
|
+
#Get Agent Voicemails
|
1776
|
+
result = api_instance.get_pbx_agent_voicemails
|
1777
|
+
p result
|
1778
|
+
rescue UltracartClient::ApiError => e
|
1779
|
+
puts "Exception when calling ConversationApi->get_pbx_agent_voicemails: #{e}"
|
1780
|
+
end
|
1781
|
+
```
|
1782
|
+
|
1783
|
+
### Parameters
|
1784
|
+
This endpoint does not need any parameter.
|
1785
|
+
|
1786
|
+
### Return type
|
1787
|
+
|
1788
|
+
[**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
|
1789
|
+
|
1790
|
+
### Authorization
|
1791
|
+
|
1792
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1793
|
+
|
1794
|
+
### HTTP request headers
|
1795
|
+
|
1796
|
+
- **Content-Type**: application/json
|
1797
|
+
- **Accept**: application/json
|
1798
|
+
|
1799
|
+
|
1800
|
+
|
1651
1801
|
# **get_pbx_agents**
|
1652
1802
|
> ConversationPbxAgentsResponse get_pbx_agents
|
1653
1803
|
|
@@ -2028,6 +2178,109 @@ Name | Type | Description | Notes
|
|
2028
2178
|
|
2029
2179
|
|
2030
2180
|
|
2181
|
+
# **get_pbx_queue_voicemail**
|
2182
|
+
> ConversationPbxVoicemailMessageResponse get_pbx_queue_voicemail(queue_uuid, recording_sid)
|
2183
|
+
|
2184
|
+
Get Queue Voicemail
|
2185
|
+
|
2186
|
+
Retrieve pbx queue Voicemail
|
2187
|
+
|
2188
|
+
### Example
|
2189
|
+
```ruby
|
2190
|
+
# load the gem
|
2191
|
+
require 'ultracart_api'
|
2192
|
+
|
2193
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2194
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2195
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
2196
|
+
|
2197
|
+
|
2198
|
+
queue_uuid = 'queue_uuid_example' # String |
|
2199
|
+
|
2200
|
+
recording_sid = 'recording_sid_example' # String |
|
2201
|
+
|
2202
|
+
|
2203
|
+
begin
|
2204
|
+
#Get Queue Voicemail
|
2205
|
+
result = api_instance.get_pbx_queue_voicemail(queue_uuid, recording_sid)
|
2206
|
+
p result
|
2207
|
+
rescue UltracartClient::ApiError => e
|
2208
|
+
puts "Exception when calling ConversationApi->get_pbx_queue_voicemail: #{e}"
|
2209
|
+
end
|
2210
|
+
```
|
2211
|
+
|
2212
|
+
### Parameters
|
2213
|
+
|
2214
|
+
Name | Type | Description | Notes
|
2215
|
+
------------- | ------------- | ------------- | -------------
|
2216
|
+
**queue_uuid** | **String**| |
|
2217
|
+
**recording_sid** | **String**| |
|
2218
|
+
|
2219
|
+
### Return type
|
2220
|
+
|
2221
|
+
[**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
|
2222
|
+
|
2223
|
+
### Authorization
|
2224
|
+
|
2225
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2226
|
+
|
2227
|
+
### HTTP request headers
|
2228
|
+
|
2229
|
+
- **Content-Type**: application/json
|
2230
|
+
- **Accept**: application/json
|
2231
|
+
|
2232
|
+
|
2233
|
+
|
2234
|
+
# **get_pbx_queue_voicemails**
|
2235
|
+
> ConversationPbxVoicemailMessageSummariesResponse get_pbx_queue_voicemails(queue_uuid)
|
2236
|
+
|
2237
|
+
Get Queue Voicemails
|
2238
|
+
|
2239
|
+
Retrieve pbx queue voicemails
|
2240
|
+
|
2241
|
+
### Example
|
2242
|
+
```ruby
|
2243
|
+
# load the gem
|
2244
|
+
require 'ultracart_api'
|
2245
|
+
|
2246
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2247
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2248
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
2249
|
+
|
2250
|
+
|
2251
|
+
queue_uuid = 'queue_uuid_example' # String |
|
2252
|
+
|
2253
|
+
|
2254
|
+
begin
|
2255
|
+
#Get Queue Voicemails
|
2256
|
+
result = api_instance.get_pbx_queue_voicemails(queue_uuid)
|
2257
|
+
p result
|
2258
|
+
rescue UltracartClient::ApiError => e
|
2259
|
+
puts "Exception when calling ConversationApi->get_pbx_queue_voicemails: #{e}"
|
2260
|
+
end
|
2261
|
+
```
|
2262
|
+
|
2263
|
+
### Parameters
|
2264
|
+
|
2265
|
+
Name | Type | Description | Notes
|
2266
|
+
------------- | ------------- | ------------- | -------------
|
2267
|
+
**queue_uuid** | **String**| |
|
2268
|
+
|
2269
|
+
### Return type
|
2270
|
+
|
2271
|
+
[**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
|
2272
|
+
|
2273
|
+
### Authorization
|
2274
|
+
|
2275
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2276
|
+
|
2277
|
+
### HTTP request headers
|
2278
|
+
|
2279
|
+
- **Content-Type**: application/json
|
2280
|
+
- **Accept**: application/json
|
2281
|
+
|
2282
|
+
|
2283
|
+
|
2031
2284
|
# **get_pbx_queues**
|
2032
2285
|
> ConversationPbxQueuesResponse get_pbx_queues
|
2033
2286
|
|
@@ -3010,6 +3263,55 @@ nil (empty response body)
|
|
3010
3263
|
|
3011
3264
|
|
3012
3265
|
|
3266
|
+
# **listened_pbx_agent_voicemail**
|
3267
|
+
> listened_pbx_agent_voicemail(recording_sid)
|
3268
|
+
|
3269
|
+
Listened Agent Voicemail
|
3270
|
+
|
3271
|
+
Listened pbx agent Voicemail
|
3272
|
+
|
3273
|
+
### Example
|
3274
|
+
```ruby
|
3275
|
+
# load the gem
|
3276
|
+
require 'ultracart_api'
|
3277
|
+
|
3278
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
3279
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
3280
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
3281
|
+
|
3282
|
+
|
3283
|
+
recording_sid = 'recording_sid_example' # String |
|
3284
|
+
|
3285
|
+
|
3286
|
+
begin
|
3287
|
+
#Listened Agent Voicemail
|
3288
|
+
api_instance.listened_pbx_agent_voicemail(recording_sid)
|
3289
|
+
rescue UltracartClient::ApiError => e
|
3290
|
+
puts "Exception when calling ConversationApi->listened_pbx_agent_voicemail: #{e}"
|
3291
|
+
end
|
3292
|
+
```
|
3293
|
+
|
3294
|
+
### Parameters
|
3295
|
+
|
3296
|
+
Name | Type | Description | Notes
|
3297
|
+
------------- | ------------- | ------------- | -------------
|
3298
|
+
**recording_sid** | **String**| |
|
3299
|
+
|
3300
|
+
### Return type
|
3301
|
+
|
3302
|
+
nil (empty response body)
|
3303
|
+
|
3304
|
+
### Authorization
|
3305
|
+
|
3306
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3307
|
+
|
3308
|
+
### HTTP request headers
|
3309
|
+
|
3310
|
+
- **Content-Type**: application/json
|
3311
|
+
- **Accept**: application/json
|
3312
|
+
|
3313
|
+
|
3314
|
+
|
3013
3315
|
# **mark_read_conversation**
|
3014
3316
|
> mark_read_conversation(conversation_uuid)
|
3015
3317
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**call_sid** | **String** | Call SID | [optional]
|
7
|
+
**duration** | **Integer** | Duration in seconds | [optional]
|
8
|
+
**from** | **String** | From phone number in E.164 | [optional]
|
9
|
+
**from_caller_id** | **String** | From caller id (if available) | [optional]
|
10
|
+
**listened** | **BOOLEAN** | True if the voicemail has been listened to in the user interface | [optional]
|
11
|
+
**merchant_id** | **String** | Merchant ID | [optional]
|
12
|
+
**recording_sid** | **String** | Recording SID | [optional]
|
13
|
+
**recording_size_bytes** | **Integer** | Recording size in bytes | [optional]
|
14
|
+
**recording_status** | **String** | Recording Status | [optional]
|
15
|
+
**recording_url** | **String** | Recording URL (expires in 4 hours) | [optional]
|
16
|
+
**transcript_json** | **String** | JSON version of the transcript | [optional]
|
17
|
+
**transcript_text** | **String** | Formatted text of the transcript | [optional]
|
18
|
+
**voicemail_dts** | **String** | Voicemail date/time | [optional]
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
9
|
+
**voicemail_message** | [**ConversationPbxVoicemailMessage**](ConversationPbxVoicemailMessage.md) | | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageSummariesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
9
|
+
**voicemail_message_summaries** | [**Array<ConversationPbxVoicemailMessageSummary>**](ConversationPbxVoicemailMessageSummary.md) | | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailMessageSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**call_sid** | **String** | Call SID | [optional]
|
7
|
+
**duration** | **Integer** | Duration in seconds | [optional]
|
8
|
+
**from** | **String** | From phone number in E.164 | [optional]
|
9
|
+
**from_caller_id** | **String** | From caller id (if available) | [optional]
|
10
|
+
**listened** | **BOOLEAN** | True if the voicemail has been listened to in the user interface | [optional]
|
11
|
+
**merchant_id** | **String** | Merchant ID | [optional]
|
12
|
+
**recording_sid** | **String** | Recording SID | [optional]
|
13
|
+
**recording_size_bytes** | **Integer** | Recording size in bytes | [optional]
|
14
|
+
**recording_status** | **String** | Recording Status | [optional]
|
15
|
+
**voicemail_dts** | **String** | Voicemail date/time | [optional]
|
16
|
+
|
17
|
+
|