ultracart_api 4.1.71 → 4.1.73
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 +7 -2
- data/docs/ConversationApi.md +52 -0
- data/docs/ConversationPbxCall.md +7 -1
- data/docs/ConversationPbxCallAiSummary.md +38 -0
- data/docs/ConversationPbxCallFinancial.md +2 -0
- data/docs/ConversationPbxQueue.md +9 -1
- data/docs/ConversationPbxVoicemailCapabilitiesResponse.md +28 -0
- data/docs/ConversationPbxVoicemailMailbox.md +4 -0
- data/lib/ultracart_api/api/conversation_api.rb +58 -0
- data/lib/ultracart_api/models/conversation_pbx_call.rb +33 -4
- data/lib/ultracart_api/models/conversation_pbx_call_ai_summary.rb +358 -0
- data/lib/ultracart_api/models/conversation_pbx_call_financial.rb +11 -1
- data/lib/ultracart_api/models/conversation_pbx_queue.rb +74 -4
- data/lib/ultracart_api/models/conversation_pbx_voicemail_capabilities_response.rb +269 -0
- data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +53 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +2 -0
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2b012c1c1cb42f56eec70a9c9a782b0eb04ca2c3350588e242288ec4e371eecc
|
|
4
|
+
data.tar.gz: 0c6e5c3b3e6a6e40fb4f025785f14555fd8202467297f476122c1c76028802f2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b93742d5f5b6ddecaf89d65236de195902591c0deebc3b1c00476f6dcca5e326a920d8649a13f5d6ea990c68021b0277982a761987e9512ada2e55e21cde7b3d
|
|
7
|
+
data.tar.gz: ac4ffda51157a410e93dbf9ea409610f68f3cfdb6866614149e70fc7e5d56895a44d59f7e9c0154acfb35baf0ac56e185cb5dbcd3b20e46533b2db48817b35b6
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
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.1.
|
|
10
|
+
- Package version: 4.1.73
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.73'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -205,6 +205,7 @@ Class | Method | HTTP request | Description
|
|
|
205
205
|
*UltracartClient::ConversationApi* | [**get_pbx_time_baseds**](docs/ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
|
|
206
206
|
*UltracartClient::ConversationApi* | [**get_pbx_time_range**](docs/ConversationApi.md#get_pbx_time_range) | **GET** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Get pbx timeRange
|
|
207
207
|
*UltracartClient::ConversationApi* | [**get_pbx_time_ranges**](docs/ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
|
|
208
|
+
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_capabilities**](docs/ConversationApi.md#get_pbx_voicemail_capabilities) | **GET** /conversation/pbx/voicemail/capabilities | Get pbx voicemail capabilities
|
|
208
209
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailbox**](docs/ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
|
|
209
210
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
|
|
210
211
|
*UltracartClient::ConversationApi* | [**get_user_pbx_audio**](docs/ConversationApi.md#get_user_pbx_audio) | **GET** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Get user pbx audio
|
|
@@ -864,6 +865,7 @@ Class | Method | HTTP request | Description
|
|
|
864
865
|
- [UltracartClient::ConversationPbxCallAgent](docs/ConversationPbxCallAgent.md)
|
|
865
866
|
- [UltracartClient::ConversationPbxCallAiCost](docs/ConversationPbxCallAiCost.md)
|
|
866
867
|
- [UltracartClient::ConversationPbxCallAiEngagement](docs/ConversationPbxCallAiEngagement.md)
|
|
868
|
+
- [UltracartClient::ConversationPbxCallAiSummary](docs/ConversationPbxCallAiSummary.md)
|
|
867
869
|
- [UltracartClient::ConversationPbxCallAiToolCall](docs/ConversationPbxCallAiToolCall.md)
|
|
868
870
|
- [UltracartClient::ConversationPbxCallAiWhisper](docs/ConversationPbxCallAiWhisper.md)
|
|
869
871
|
- [UltracartClient::ConversationPbxCallCaller](docs/ConversationPbxCallCaller.md)
|
|
@@ -913,6 +915,7 @@ Class | Method | HTTP request | Description
|
|
|
913
915
|
- [UltracartClient::ConversationPbxTimeRangeConfig](docs/ConversationPbxTimeRangeConfig.md)
|
|
914
916
|
- [UltracartClient::ConversationPbxTimeRangeResponse](docs/ConversationPbxTimeRangeResponse.md)
|
|
915
917
|
- [UltracartClient::ConversationPbxTimeRangesResponse](docs/ConversationPbxTimeRangesResponse.md)
|
|
918
|
+
- [UltracartClient::ConversationPbxVoicemailCapabilitiesResponse](docs/ConversationPbxVoicemailCapabilitiesResponse.md)
|
|
916
919
|
- [UltracartClient::ConversationPbxVoicemailMailbox](docs/ConversationPbxVoicemailMailbox.md)
|
|
917
920
|
- [UltracartClient::ConversationPbxVoicemailMailboxResponse](docs/ConversationPbxVoicemailMailboxResponse.md)
|
|
918
921
|
- [UltracartClient::ConversationPbxVoicemailMailboxesResponse](docs/ConversationPbxVoicemailMailboxesResponse.md)
|
|
@@ -1687,6 +1690,8 @@ Not every change is committed to every SDK.
|
|
|
1687
1690
|
|
|
1688
1691
|
| Version | Date | Comments |
|
|
1689
1692
|
| --: | :-: | --- |
|
|
1693
|
+
| 4.1.73 | 04/13/2026 | conversation pbx - queue configuration for ai summary and call record zoho desk |
|
|
1694
|
+
| 4.1.72 | 04/11/2026 | conversation pbx - voicemail notification channels |
|
|
1690
1695
|
| 4.1.71 | 04/06/2026 | coupons - new percent_off_items_with_minimum_item_amount |
|
|
1691
1696
|
| 4.1.70 | 04/03/2026 | conversation pbx - queue callback settings |
|
|
1692
1697
|
| 4.1.69 | 03/31/2026 | conversations - user specific audio methods |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -77,6 +77,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
77
77
|
| [**get_pbx_time_baseds**](ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds |
|
|
78
78
|
| [**get_pbx_time_range**](ConversationApi.md#get_pbx_time_range) | **GET** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Get pbx timeRange |
|
|
79
79
|
| [**get_pbx_time_ranges**](ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges |
|
|
80
|
+
| [**get_pbx_voicemail_capabilities**](ConversationApi.md#get_pbx_voicemail_capabilities) | **GET** /conversation/pbx/voicemail/capabilities | Get pbx voicemail capabilities |
|
|
80
81
|
| [**get_pbx_voicemail_mailbox**](ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox |
|
|
81
82
|
| [**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes |
|
|
82
83
|
| [**get_user_pbx_audio**](ConversationApi.md#get_user_pbx_audio) | **GET** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Get user pbx audio |
|
|
@@ -4024,6 +4025,57 @@ This endpoint does not need any parameter.
|
|
|
4024
4025
|
- **Accept**: application/json
|
|
4025
4026
|
|
|
4026
4027
|
|
|
4028
|
+
## get_pbx_voicemail_capabilities
|
|
4029
|
+
|
|
4030
|
+
> <ConversationPbxVoicemailCapabilitiesResponse> get_pbx_voicemail_capabilities
|
|
4031
|
+
|
|
4032
|
+
Get pbx voicemail capabilities
|
|
4033
|
+
|
|
4034
|
+
Retrieve voicemail notification capabilities including available channels
|
|
4035
|
+
|
|
4036
|
+
|
|
4037
|
+
### Examples
|
|
4038
|
+
|
|
4039
|
+
|
|
4040
|
+
(No example for this operation).
|
|
4041
|
+
|
|
4042
|
+
|
|
4043
|
+
#### Using the get_pbx_voicemail_capabilities_with_http_info variant
|
|
4044
|
+
|
|
4045
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4046
|
+
|
|
4047
|
+
> <Array(<ConversationPbxVoicemailCapabilitiesResponse>, Integer, Hash)> get_pbx_voicemail_capabilities_with_http_info
|
|
4048
|
+
|
|
4049
|
+
```ruby
|
|
4050
|
+
begin
|
|
4051
|
+
# Get pbx voicemail capabilities
|
|
4052
|
+
data, status_code, headers = api_instance.get_pbx_voicemail_capabilities_with_http_info
|
|
4053
|
+
p status_code # => 2xx
|
|
4054
|
+
p headers # => { ... }
|
|
4055
|
+
p data # => <ConversationPbxVoicemailCapabilitiesResponse>
|
|
4056
|
+
rescue UltracartClient::ApiError => e
|
|
4057
|
+
puts "Error when calling ConversationApi->get_pbx_voicemail_capabilities_with_http_info: #{e}"
|
|
4058
|
+
end
|
|
4059
|
+
```
|
|
4060
|
+
|
|
4061
|
+
### Parameters
|
|
4062
|
+
|
|
4063
|
+
This endpoint does not need any parameter.
|
|
4064
|
+
|
|
4065
|
+
### Return type
|
|
4066
|
+
|
|
4067
|
+
[**ConversationPbxVoicemailCapabilitiesResponse**](ConversationPbxVoicemailCapabilitiesResponse.md)
|
|
4068
|
+
|
|
4069
|
+
### Authorization
|
|
4070
|
+
|
|
4071
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4072
|
+
|
|
4073
|
+
### HTTP request headers
|
|
4074
|
+
|
|
4075
|
+
- **Content-Type**: Not defined
|
|
4076
|
+
- **Accept**: application/json
|
|
4077
|
+
|
|
4078
|
+
|
|
4027
4079
|
## get_pbx_voicemail_mailbox
|
|
4028
4080
|
|
|
4029
4081
|
> <ConversationPbxVoicemailMailboxResponse> get_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
|
data/docs/ConversationPbxCall.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **account_sid** | **String** | Twilio account SID | [optional] |
|
|
8
8
|
| **agents** | [**Array<ConversationPbxCallAgent>**](ConversationPbxCallAgent.md) | List of agents who participated in this call | [optional] |
|
|
9
9
|
| **ai_agent_engagements** | [**Array<ConversationPbxCallAiEngagement>**](ConversationPbxCallAiEngagement.md) | List of AI agent engagements during the call | [optional] |
|
|
10
|
+
| **ai_summary** | [**ConversationPbxCallAiSummary**](ConversationPbxCallAiSummary.md) | | [optional] |
|
|
10
11
|
| **call_sid** | **String** | Twilio call SID for the primary (customer) call leg | [optional] |
|
|
11
12
|
| **call_uuid** | **String** | Unique identifier for this call record | [optional] |
|
|
12
13
|
| **caller** | [**ConversationPbxCallCaller**](ConversationPbxCallCaller.md) | | [optional] |
|
|
@@ -26,6 +27,8 @@
|
|
|
26
27
|
| **timeline** | [**ConversationPbxCallTimeline**](ConversationPbxCallTimeline.md) | | [optional] |
|
|
27
28
|
| **transfers** | [**Array<ConversationPbxCallTransfer>**](ConversationPbxCallTransfer.md) | List of transfer events during the call | [optional] |
|
|
28
29
|
| **updated_at_dts** | **String** | Timestamp when the call record was last updated | [optional] |
|
|
30
|
+
| **zoho_desk_ticket_id** | **String** | Zoho Desk ticket ID if a ticket was created for this call | [optional] |
|
|
31
|
+
| **zoho_desk_ticket_url** | **String** | URL to the Zoho Desk ticket if a ticket was created for this call | [optional] |
|
|
29
32
|
|
|
30
33
|
## Example
|
|
31
34
|
|
|
@@ -36,6 +39,7 @@ instance = UltracartClient::ConversationPbxCall.new(
|
|
|
36
39
|
account_sid: null,
|
|
37
40
|
agents: null,
|
|
38
41
|
ai_agent_engagements: null,
|
|
42
|
+
ai_summary: null,
|
|
39
43
|
call_sid: null,
|
|
40
44
|
call_uuid: null,
|
|
41
45
|
caller: null,
|
|
@@ -54,7 +58,9 @@ instance = UltracartClient::ConversationPbxCall.new(
|
|
|
54
58
|
status: null,
|
|
55
59
|
timeline: null,
|
|
56
60
|
transfers: null,
|
|
57
|
-
updated_at_dts: null
|
|
61
|
+
updated_at_dts: null,
|
|
62
|
+
zoho_desk_ticket_id: null,
|
|
63
|
+
zoho_desk_ticket_url: null
|
|
58
64
|
)
|
|
59
65
|
```
|
|
60
66
|
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCallAiSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action_items** | **Array<String>** | Action items identified during the call | [optional] |
|
|
8
|
+
| **call_category** | **String** | Category of the call (e.g. support, sales, billing) | [optional] |
|
|
9
|
+
| **completion_tokens** | **Integer** | Number of output tokens used to generate the summary | [optional] |
|
|
10
|
+
| **cost** | **Float** | Cost of generating the summary in the specified currency | [optional] |
|
|
11
|
+
| **cost_currency** | **String** | Currency code for the summary cost (always USD) | [optional] |
|
|
12
|
+
| **generated_at_dts** | **String** | Timestamp when the summary was generated | [optional] |
|
|
13
|
+
| **key_topics** | **Array<String>** | Key topics discussed during the call | [optional] |
|
|
14
|
+
| **model** | **String** | AI model used to generate the summary (e.g. grok-4.1-fast) | [optional] |
|
|
15
|
+
| **prompt_tokens** | **Integer** | Number of input tokens used to generate the summary | [optional] |
|
|
16
|
+
| **sentiment** | **String** | Overall sentiment of the call | [optional] |
|
|
17
|
+
| **summary** | **String** | 2-3 sentence synopsis of the call | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'ultracart_api'
|
|
23
|
+
|
|
24
|
+
instance = UltracartClient::ConversationPbxCallAiSummary.new(
|
|
25
|
+
action_items: null,
|
|
26
|
+
call_category: null,
|
|
27
|
+
completion_tokens: null,
|
|
28
|
+
cost: null,
|
|
29
|
+
cost_currency: null,
|
|
30
|
+
generated_at_dts: null,
|
|
31
|
+
key_topics: null,
|
|
32
|
+
model: null,
|
|
33
|
+
prompt_tokens: null,
|
|
34
|
+
sentiment: null,
|
|
35
|
+
summary: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **ai_agent_billed_minutes** | **Float** | Total AI agent billed minutes for this call | [optional] |
|
|
8
8
|
| **ai_agent_cost** | **Float** | Total AI agent cost for this call | [optional] |
|
|
9
9
|
| **ai_agent_cost_currency** | **String** | Currency for AI agent cost | [optional] |
|
|
10
|
+
| **ai_summary_cost** | **Float** | AI summary generation cost (LLM call made by pbx-transcript-formatter after the call ends) | [optional] |
|
|
10
11
|
| **call_currency** | **String** | Currency for call price (default USD) | [optional] |
|
|
11
12
|
| **call_price** | **Float** | Twilio call cost | [optional] |
|
|
12
13
|
| **call_price_estimated** | **Boolean** | True if call price is a fallback-rate estimate, false if Twilio-confirmed | [optional] |
|
|
@@ -21,6 +22,7 @@ instance = UltracartClient::ConversationPbxCallFinancial.new(
|
|
|
21
22
|
ai_agent_billed_minutes: null,
|
|
22
23
|
ai_agent_cost: null,
|
|
23
24
|
ai_agent_cost_currency: null,
|
|
25
|
+
ai_summary_cost: null,
|
|
24
26
|
call_currency: null,
|
|
25
27
|
call_price: null,
|
|
26
28
|
call_price_estimated: null,
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **ai_priority** | **String** | AI Agent Priority compared to human agents | [optional] |
|
|
8
|
+
| **ai_summary_enabled** | **Boolean** | If true, AI summaries are generated for answered calls in this queue | [optional] |
|
|
9
|
+
| **ai_summary_instructions** | **String** | Custom instructions injected into the AI summary system prompt for this queue | [optional] |
|
|
8
10
|
| **ai_timeout_seconds** | **Integer** | AI timeout seconds | [optional] |
|
|
9
11
|
| **announce_queue_position** | **Boolean** | If true, the customer is told their queue position upon entering the queue | [optional] |
|
|
10
12
|
| **automatic_coach_agent_uuid** | **String** | AI Agent UUID to automatically engage to provide coaching | [optional] |
|
|
@@ -40,6 +42,8 @@
|
|
|
40
42
|
| **wait_critical_seconds** | **Integer** | Wait time in seconds before critical | [optional] |
|
|
41
43
|
| **wait_warning_seconds** | **Integer** | Wait time in seconds before warning | [optional] |
|
|
42
44
|
| **wrap_up_seconds** | **Integer** | Wrap up time in seconds | [optional] |
|
|
45
|
+
| **zoho_desk_department_id** | **String** | Zoho Desk department ID to create tickets in | [optional] |
|
|
46
|
+
| **zoho_desk_ticket_enabled** | **Boolean** | If true, a Zoho Desk ticket is automatically created for answered calls in this queue | [optional] |
|
|
43
47
|
|
|
44
48
|
## Example
|
|
45
49
|
|
|
@@ -48,6 +52,8 @@ require 'ultracart_api'
|
|
|
48
52
|
|
|
49
53
|
instance = UltracartClient::ConversationPbxQueue.new(
|
|
50
54
|
ai_priority: null,
|
|
55
|
+
ai_summary_enabled: null,
|
|
56
|
+
ai_summary_instructions: null,
|
|
51
57
|
ai_timeout_seconds: null,
|
|
52
58
|
announce_queue_position: null,
|
|
53
59
|
automatic_coach_agent_uuid: null,
|
|
@@ -82,7 +88,9 @@ instance = UltracartClient::ConversationPbxQueue.new(
|
|
|
82
88
|
voicemail: null,
|
|
83
89
|
wait_critical_seconds: null,
|
|
84
90
|
wait_warning_seconds: null,
|
|
85
|
-
wrap_up_seconds: null
|
|
91
|
+
wrap_up_seconds: null,
|
|
92
|
+
zoho_desk_department_id: null,
|
|
93
|
+
zoho_desk_ticket_enabled: null
|
|
86
94
|
)
|
|
87
95
|
```
|
|
88
96
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxVoicemailCapabilitiesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
9
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
10
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
11
|
+
| **zoho_desk_available** | **Boolean** | True if Zoho Desk is connected to UltraCart | [optional] |
|
|
12
|
+
| **zoho_desk_departments** | [**Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>**](ConversationVirtualAgentCapabilityZohoDeskDepartment.md) | Array of Zoho Desk Departments if Zoho Desk is connected to UltraCart | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::ConversationPbxVoicemailCapabilitiesResponse.new(
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null,
|
|
24
|
+
zoho_desk_available: null,
|
|
25
|
+
zoho_desk_departments: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -6,7 +6,9 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **conversation_pbx_voicemail_mailbox_uuid** | **String** | Conversation Pbx Voicemail Mailbox UUID | [optional] |
|
|
8
8
|
| **merchant_id** | **String** | Merchant Id | [optional] |
|
|
9
|
+
| **send_notices_to_channel** | **String** | Send notices to channel | [optional] |
|
|
9
10
|
| **send_notices_to_email** | **String** | Send notices to email | [optional] |
|
|
11
|
+
| **send_notices_to_zoho_desk_department_id** | **String** | Send notices to Zoho Desk department id | [optional] |
|
|
10
12
|
| **user_id** | **Integer** | User Id | [optional] |
|
|
11
13
|
| **voicemail_followup_play_audio_uuid** | **String** | Voicemail follow play audio UUID | [optional] |
|
|
12
14
|
| **voicemail_followup_say** | **String** | Voicemail followup say | [optional] |
|
|
@@ -25,7 +27,9 @@ require 'ultracart_api'
|
|
|
25
27
|
instance = UltracartClient::ConversationPbxVoicemailMailbox.new(
|
|
26
28
|
conversation_pbx_voicemail_mailbox_uuid: null,
|
|
27
29
|
merchant_id: null,
|
|
30
|
+
send_notices_to_channel: null,
|
|
28
31
|
send_notices_to_email: null,
|
|
32
|
+
send_notices_to_zoho_desk_department_id: null,
|
|
29
33
|
user_id: null,
|
|
30
34
|
voicemail_followup_play_audio_uuid: null,
|
|
31
35
|
voicemail_followup_say: null,
|
|
@@ -4647,6 +4647,64 @@ module UltracartClient
|
|
|
4647
4647
|
return data, status_code, headers
|
|
4648
4648
|
end
|
|
4649
4649
|
|
|
4650
|
+
# Get pbx voicemail capabilities
|
|
4651
|
+
# Retrieve voicemail notification capabilities including available channels
|
|
4652
|
+
# @param [Hash] opts the optional parameters
|
|
4653
|
+
# @return [ConversationPbxVoicemailCapabilitiesResponse]
|
|
4654
|
+
def get_pbx_voicemail_capabilities(opts = {})
|
|
4655
|
+
data, _status_code, _headers = get_pbx_voicemail_capabilities_with_http_info(opts)
|
|
4656
|
+
data
|
|
4657
|
+
end
|
|
4658
|
+
|
|
4659
|
+
# Get pbx voicemail capabilities
|
|
4660
|
+
# Retrieve voicemail notification capabilities including available channels
|
|
4661
|
+
# @param [Hash] opts the optional parameters
|
|
4662
|
+
# @return [Array<(ConversationPbxVoicemailCapabilitiesResponse, Integer, Hash)>] ConversationPbxVoicemailCapabilitiesResponse data, response status code and response headers
|
|
4663
|
+
def get_pbx_voicemail_capabilities_with_http_info(opts = {})
|
|
4664
|
+
if @api_client.config.debugging
|
|
4665
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_voicemail_capabilities ...'
|
|
4666
|
+
end
|
|
4667
|
+
# resource path
|
|
4668
|
+
local_var_path = '/conversation/pbx/voicemail/capabilities'
|
|
4669
|
+
|
|
4670
|
+
# query parameters
|
|
4671
|
+
query_params = opts[:query_params] || {}
|
|
4672
|
+
|
|
4673
|
+
# header parameters
|
|
4674
|
+
header_params = opts[:header_params] || {}
|
|
4675
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4676
|
+
# HTTP header 'Accept' (if needed)
|
|
4677
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4678
|
+
|
|
4679
|
+
# form parameters
|
|
4680
|
+
form_params = opts[:form_params] || {}
|
|
4681
|
+
|
|
4682
|
+
# http body (model)
|
|
4683
|
+
post_body = opts[:debug_body]
|
|
4684
|
+
|
|
4685
|
+
# return_type
|
|
4686
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxVoicemailCapabilitiesResponse'
|
|
4687
|
+
|
|
4688
|
+
# auth_names
|
|
4689
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4690
|
+
|
|
4691
|
+
new_options = opts.merge(
|
|
4692
|
+
:operation => :"ConversationApi.get_pbx_voicemail_capabilities",
|
|
4693
|
+
:header_params => header_params,
|
|
4694
|
+
:query_params => query_params,
|
|
4695
|
+
:form_params => form_params,
|
|
4696
|
+
:body => post_body,
|
|
4697
|
+
:auth_names => auth_names,
|
|
4698
|
+
:return_type => return_type
|
|
4699
|
+
)
|
|
4700
|
+
|
|
4701
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4702
|
+
if @api_client.config.debugging
|
|
4703
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_pbx_voicemail_capabilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4704
|
+
end
|
|
4705
|
+
return data, status_code, headers
|
|
4706
|
+
end
|
|
4707
|
+
|
|
4650
4708
|
# Get pbx voicemailMailbox
|
|
4651
4709
|
# Retrieve a pbx voicemailMailbox
|
|
4652
4710
|
# @param conversation_pbx_voicemail_mailbox_uuid [String]
|
|
@@ -24,6 +24,8 @@ module UltracartClient
|
|
|
24
24
|
# List of AI agent engagements during the call
|
|
25
25
|
attr_accessor :ai_agent_engagements
|
|
26
26
|
|
|
27
|
+
attr_accessor :ai_summary
|
|
28
|
+
|
|
27
29
|
# Twilio call SID for the primary (customer) call leg
|
|
28
30
|
attr_accessor :call_sid
|
|
29
31
|
|
|
@@ -77,12 +79,19 @@ module UltracartClient
|
|
|
77
79
|
# Timestamp when the call record was last updated
|
|
78
80
|
attr_accessor :updated_at_dts
|
|
79
81
|
|
|
82
|
+
# Zoho Desk ticket ID if a ticket was created for this call
|
|
83
|
+
attr_accessor :zoho_desk_ticket_id
|
|
84
|
+
|
|
85
|
+
# URL to the Zoho Desk ticket if a ticket was created for this call
|
|
86
|
+
attr_accessor :zoho_desk_ticket_url
|
|
87
|
+
|
|
80
88
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
81
89
|
def self.attribute_map
|
|
82
90
|
{
|
|
83
91
|
:'account_sid' => :'account_sid',
|
|
84
92
|
:'agents' => :'agents',
|
|
85
93
|
:'ai_agent_engagements' => :'ai_agent_engagements',
|
|
94
|
+
:'ai_summary' => :'ai_summary',
|
|
86
95
|
:'call_sid' => :'call_sid',
|
|
87
96
|
:'call_uuid' => :'call_uuid',
|
|
88
97
|
:'caller' => :'caller',
|
|
@@ -101,7 +110,9 @@ module UltracartClient
|
|
|
101
110
|
:'status' => :'status',
|
|
102
111
|
:'timeline' => :'timeline',
|
|
103
112
|
:'transfers' => :'transfers',
|
|
104
|
-
:'updated_at_dts' => :'updated_at_dts'
|
|
113
|
+
:'updated_at_dts' => :'updated_at_dts',
|
|
114
|
+
:'zoho_desk_ticket_id' => :'zoho_desk_ticket_id',
|
|
115
|
+
:'zoho_desk_ticket_url' => :'zoho_desk_ticket_url'
|
|
105
116
|
}
|
|
106
117
|
end
|
|
107
118
|
|
|
@@ -116,6 +127,7 @@ module UltracartClient
|
|
|
116
127
|
:'account_sid' => :'String',
|
|
117
128
|
:'agents' => :'Array<ConversationPbxCallAgent>',
|
|
118
129
|
:'ai_agent_engagements' => :'Array<ConversationPbxCallAiEngagement>',
|
|
130
|
+
:'ai_summary' => :'ConversationPbxCallAiSummary',
|
|
119
131
|
:'call_sid' => :'String',
|
|
120
132
|
:'call_uuid' => :'String',
|
|
121
133
|
:'caller' => :'ConversationPbxCallCaller',
|
|
@@ -134,7 +146,9 @@ module UltracartClient
|
|
|
134
146
|
:'status' => :'String',
|
|
135
147
|
:'timeline' => :'ConversationPbxCallTimeline',
|
|
136
148
|
:'transfers' => :'Array<ConversationPbxCallTransfer>',
|
|
137
|
-
:'updated_at_dts' => :'String'
|
|
149
|
+
:'updated_at_dts' => :'String',
|
|
150
|
+
:'zoho_desk_ticket_id' => :'String',
|
|
151
|
+
:'zoho_desk_ticket_url' => :'String'
|
|
138
152
|
}
|
|
139
153
|
end
|
|
140
154
|
|
|
@@ -175,6 +189,10 @@ module UltracartClient
|
|
|
175
189
|
end
|
|
176
190
|
end
|
|
177
191
|
|
|
192
|
+
if attributes.key?(:'ai_summary')
|
|
193
|
+
self.ai_summary = attributes[:'ai_summary']
|
|
194
|
+
end
|
|
195
|
+
|
|
178
196
|
if attributes.key?(:'call_sid')
|
|
179
197
|
self.call_sid = attributes[:'call_sid']
|
|
180
198
|
end
|
|
@@ -258,6 +276,14 @@ module UltracartClient
|
|
|
258
276
|
if attributes.key?(:'updated_at_dts')
|
|
259
277
|
self.updated_at_dts = attributes[:'updated_at_dts']
|
|
260
278
|
end
|
|
279
|
+
|
|
280
|
+
if attributes.key?(:'zoho_desk_ticket_id')
|
|
281
|
+
self.zoho_desk_ticket_id = attributes[:'zoho_desk_ticket_id']
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
if attributes.key?(:'zoho_desk_ticket_url')
|
|
285
|
+
self.zoho_desk_ticket_url = attributes[:'zoho_desk_ticket_url']
|
|
286
|
+
end
|
|
261
287
|
end
|
|
262
288
|
|
|
263
289
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -281,6 +307,7 @@ module UltracartClient
|
|
|
281
307
|
account_sid == o.account_sid &&
|
|
282
308
|
agents == o.agents &&
|
|
283
309
|
ai_agent_engagements == o.ai_agent_engagements &&
|
|
310
|
+
ai_summary == o.ai_summary &&
|
|
284
311
|
call_sid == o.call_sid &&
|
|
285
312
|
call_uuid == o.call_uuid &&
|
|
286
313
|
caller == o.caller &&
|
|
@@ -299,7 +326,9 @@ module UltracartClient
|
|
|
299
326
|
status == o.status &&
|
|
300
327
|
timeline == o.timeline &&
|
|
301
328
|
transfers == o.transfers &&
|
|
302
|
-
updated_at_dts == o.updated_at_dts
|
|
329
|
+
updated_at_dts == o.updated_at_dts &&
|
|
330
|
+
zoho_desk_ticket_id == o.zoho_desk_ticket_id &&
|
|
331
|
+
zoho_desk_ticket_url == o.zoho_desk_ticket_url
|
|
303
332
|
end
|
|
304
333
|
|
|
305
334
|
# @see the `==` method
|
|
@@ -311,7 +340,7 @@ module UltracartClient
|
|
|
311
340
|
# Calculates hash code according to all attributes.
|
|
312
341
|
# @return [Integer] Hash code
|
|
313
342
|
def hash
|
|
314
|
-
[account_sid, agents, ai_agent_engagements, call_sid, call_uuid, caller, conference_sid, created_at_dts, customer_name, customer_profile_oid, disposition, email, financial, holds, merchant_id, recording_sids, recordings, routing, status, timeline, transfers, updated_at_dts].hash
|
|
343
|
+
[account_sid, agents, ai_agent_engagements, ai_summary, call_sid, call_uuid, caller, conference_sid, created_at_dts, customer_name, customer_profile_oid, disposition, email, financial, holds, merchant_id, recording_sids, recordings, routing, status, timeline, transfers, updated_at_dts, zoho_desk_ticket_id, zoho_desk_ticket_url].hash
|
|
315
344
|
end
|
|
316
345
|
|
|
317
346
|
# Builds the object from hash
|