ultracart_api 4.1.68 → 4.1.69
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 +8 -2
- data/docs/ConversationApi.md +269 -0
- data/lib/ultracart_api/api/conversation_api.rb +330 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e481d72fdb9738e46385d225e85885a2f5eef1d5adf3184d9c0c91bcfe7ce5e6
|
|
4
|
+
data.tar.gz: a8c6c2a8e07465c0f7fca61546290144b22ff43825955a96a2ade115ceb88bee
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c93744277b4d469e168a557f7f4681bee3e084c9658c5ead3895b1d3f9b309a5e234fcb7fcca259fb55a5dbd73c9fe8ac603f2a14ea45b31fc0a5312c691623f
|
|
7
|
+
data.tar.gz: dfb4dc33f05e7d93b7c7a87150aa99fb540c004c7a0784726b1187689e40f459e06efe8cdd86e548cad160945d0dc4c3d7b64e26c3d109bf01c6da89423c5d50
|
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.69
|
|
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.69'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -149,6 +149,7 @@ Class | Method | HTTP request | Description
|
|
|
149
149
|
*UltracartClient::ConversationApi* | [**delete_pbx_time_based**](docs/ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
|
|
150
150
|
*UltracartClient::ConversationApi* | [**delete_pbx_time_range**](docs/ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
|
|
151
151
|
*UltracartClient::ConversationApi* | [**delete_pbx_voicemail_mailbox**](docs/ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
|
|
152
|
+
*UltracartClient::ConversationApi* | [**delete_user_pbx_audio**](docs/ConversationApi.md#delete_user_pbx_audio) | **DELETE** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Delete user pbx audio
|
|
152
153
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
153
154
|
*UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
|
154
155
|
*UltracartClient::ConversationApi* | [**get_agent_profile_knowledge_base**](docs/ConversationApi.md#get_agent_profile_knowledge_base) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base | Get the list of knowledge base documents associated with this agent profile
|
|
@@ -206,6 +207,8 @@ Class | Method | HTTP request | Description
|
|
|
206
207
|
*UltracartClient::ConversationApi* | [**get_pbx_time_ranges**](docs/ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
|
|
207
208
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailbox**](docs/ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
|
|
208
209
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
|
|
210
|
+
*UltracartClient::ConversationApi* | [**get_user_pbx_audio**](docs/ConversationApi.md#get_user_pbx_audio) | **GET** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Get user pbx audio
|
|
211
|
+
*UltracartClient::ConversationApi* | [**get_user_pbx_audios**](docs/ConversationApi.md#get_user_pbx_audios) | **GET** /conversation/pbx/audio/user | Get user pbx audios
|
|
209
212
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
|
210
213
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
|
211
214
|
*UltracartClient::ConversationApi* | [**insert_agent_profile_knowledge_base_document**](docs/ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document
|
|
@@ -222,6 +225,7 @@ Class | Method | HTTP request | Description
|
|
|
222
225
|
*UltracartClient::ConversationApi* | [**insert_pbx_time_based**](docs/ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
|
|
223
226
|
*UltracartClient::ConversationApi* | [**insert_pbx_time_range**](docs/ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange
|
|
224
227
|
*UltracartClient::ConversationApi* | [**insert_pbx_voicemail_mailbox**](docs/ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
|
|
228
|
+
*UltracartClient::ConversationApi* | [**insert_user_pbx_audio**](docs/ConversationApi.md#insert_user_pbx_audio) | **POST** /conversation/pbx/audio/user | Insert user pbx audio
|
|
225
229
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
|
226
230
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
|
227
231
|
*UltracartClient::ConversationApi* | [**listened_pbx_agent_voicemail**](docs/ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
|
|
@@ -253,6 +257,7 @@ Class | Method | HTTP request | Description
|
|
|
253
257
|
*UltracartClient::ConversationApi* | [**update_pbx_time_based**](docs/ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased
|
|
254
258
|
*UltracartClient::ConversationApi* | [**update_pbx_time_range**](docs/ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
|
|
255
259
|
*UltracartClient::ConversationApi* | [**update_pbx_voicemail_mailbox**](docs/ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
|
|
260
|
+
*UltracartClient::ConversationApi* | [**update_user_pbx_audio**](docs/ConversationApi.md#update_user_pbx_audio) | **PUT** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Update user pbx audio
|
|
256
261
|
*UltracartClient::ConversationApi* | [**update_virtual_agent_budget**](docs/ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget
|
|
257
262
|
*UltracartClient::ConversationApi* | [**update_virtual_agent_capabilities**](docs/ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
|
|
258
263
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
|
@@ -1681,6 +1686,7 @@ Not every change is committed to every SDK.
|
|
|
1681
1686
|
|
|
1682
1687
|
| Version | Date | Comments |
|
|
1683
1688
|
| --: | :-: | --- |
|
|
1689
|
+
| 4.1.69 | 03/31/2026 | conversations - user specific audio methods |
|
|
1684
1690
|
| 4.1.68 | 03/31/2026 | oauth - device support |
|
|
1685
1691
|
| 4.1.67 | 02/24/2026 | customer activity - sms and sms_stop fields added |
|
|
1686
1692
|
| 4.1.66 | 02/18/2026 | conversations - agent auth customer_profile flag |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -21,6 +21,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
21
21
|
| [**delete_pbx_time_based**](ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased |
|
|
22
22
|
| [**delete_pbx_time_range**](ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange |
|
|
23
23
|
| [**delete_pbx_voicemail_mailbox**](ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox |
|
|
24
|
+
| [**delete_user_pbx_audio**](ConversationApi.md#delete_user_pbx_audio) | **DELETE** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Delete user pbx audio |
|
|
24
25
|
| [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive |
|
|
25
26
|
| [**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile |
|
|
26
27
|
| [**get_agent_profile_knowledge_base**](ConversationApi.md#get_agent_profile_knowledge_base) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base | Get the list of knowledge base documents associated with this agent profile |
|
|
@@ -78,6 +79,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
78
79
|
| [**get_pbx_time_ranges**](ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges |
|
|
79
80
|
| [**get_pbx_voicemail_mailbox**](ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox |
|
|
80
81
|
| [**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes |
|
|
82
|
+
| [**get_user_pbx_audio**](ConversationApi.md#get_user_pbx_audio) | **GET** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Get user pbx audio |
|
|
83
|
+
| [**get_user_pbx_audios**](ConversationApi.md#get_user_pbx_audios) | **GET** /conversation/pbx/audio/user | Get user pbx audios |
|
|
81
84
|
| [**get_virtual_agent_budget**](ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget |
|
|
82
85
|
| [**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities |
|
|
83
86
|
| [**insert_agent_profile_knowledge_base_document**](ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document |
|
|
@@ -94,6 +97,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
94
97
|
| [**insert_pbx_time_based**](ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased |
|
|
95
98
|
| [**insert_pbx_time_range**](ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange |
|
|
96
99
|
| [**insert_pbx_voicemail_mailbox**](ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox |
|
|
100
|
+
| [**insert_user_pbx_audio**](ConversationApi.md#insert_user_pbx_audio) | **POST** /conversation/pbx/audio/user | Insert user pbx audio |
|
|
97
101
|
| [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
|
|
98
102
|
| [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
|
|
99
103
|
| [**listened_pbx_agent_voicemail**](ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail |
|
|
@@ -125,6 +129,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
125
129
|
| [**update_pbx_time_based**](ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased |
|
|
126
130
|
| [**update_pbx_time_range**](ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange |
|
|
127
131
|
| [**update_pbx_voicemail_mailbox**](ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox |
|
|
132
|
+
| [**update_user_pbx_audio**](ConversationApi.md#update_user_pbx_audio) | **PUT** /conversation/pbx/audio/user/{conversationPbxAudioUuid} | Update user pbx audio |
|
|
128
133
|
| [**update_virtual_agent_budget**](ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget |
|
|
129
134
|
| [**update_virtual_agent_capabilities**](ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities |
|
|
130
135
|
|
|
@@ -1045,6 +1050,59 @@ end
|
|
|
1045
1050
|
- **Accept**: application/json
|
|
1046
1051
|
|
|
1047
1052
|
|
|
1053
|
+
## delete_user_pbx_audio
|
|
1054
|
+
|
|
1055
|
+
> <ConversationPbxAudioResponse> delete_user_pbx_audio(conversation_pbx_audio_uuid)
|
|
1056
|
+
|
|
1057
|
+
Delete user pbx audio
|
|
1058
|
+
|
|
1059
|
+
Delete a pbx audio file owned by the authenticated user
|
|
1060
|
+
|
|
1061
|
+
|
|
1062
|
+
### Examples
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
(No example for this operation).
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
#### Using the delete_user_pbx_audio_with_http_info variant
|
|
1069
|
+
|
|
1070
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1071
|
+
|
|
1072
|
+
> <Array(<ConversationPbxAudioResponse>, Integer, Hash)> delete_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid)
|
|
1073
|
+
|
|
1074
|
+
```ruby
|
|
1075
|
+
begin
|
|
1076
|
+
# Delete user pbx audio
|
|
1077
|
+
data, status_code, headers = api_instance.delete_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid)
|
|
1078
|
+
p status_code # => 2xx
|
|
1079
|
+
p headers # => { ... }
|
|
1080
|
+
p data # => <ConversationPbxAudioResponse>
|
|
1081
|
+
rescue UltracartClient::ApiError => e
|
|
1082
|
+
puts "Error when calling ConversationApi->delete_user_pbx_audio_with_http_info: #{e}"
|
|
1083
|
+
end
|
|
1084
|
+
```
|
|
1085
|
+
|
|
1086
|
+
### Parameters
|
|
1087
|
+
|
|
1088
|
+
| Name | Type | Description | Notes |
|
|
1089
|
+
| ---- | ---- | ----------- | ----- |
|
|
1090
|
+
| **conversation_pbx_audio_uuid** | **String** | | |
|
|
1091
|
+
|
|
1092
|
+
### Return type
|
|
1093
|
+
|
|
1094
|
+
[**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
|
|
1095
|
+
|
|
1096
|
+
### Authorization
|
|
1097
|
+
|
|
1098
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1099
|
+
|
|
1100
|
+
### HTTP request headers
|
|
1101
|
+
|
|
1102
|
+
- **Content-Type**: Not defined
|
|
1103
|
+
- **Accept**: application/json
|
|
1104
|
+
|
|
1105
|
+
|
|
1048
1106
|
## get_agent_keep_alive
|
|
1049
1107
|
|
|
1050
1108
|
> get_agent_keep_alive
|
|
@@ -4072,6 +4130,110 @@ This endpoint does not need any parameter.
|
|
|
4072
4130
|
- **Accept**: application/json
|
|
4073
4131
|
|
|
4074
4132
|
|
|
4133
|
+
## get_user_pbx_audio
|
|
4134
|
+
|
|
4135
|
+
> <ConversationPbxAudioResponse> get_user_pbx_audio(conversation_pbx_audio_uuid)
|
|
4136
|
+
|
|
4137
|
+
Get user pbx audio
|
|
4138
|
+
|
|
4139
|
+
Retrieve a pbx audio file owned by the authenticated user
|
|
4140
|
+
|
|
4141
|
+
|
|
4142
|
+
### Examples
|
|
4143
|
+
|
|
4144
|
+
|
|
4145
|
+
(No example for this operation).
|
|
4146
|
+
|
|
4147
|
+
|
|
4148
|
+
#### Using the get_user_pbx_audio_with_http_info variant
|
|
4149
|
+
|
|
4150
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4151
|
+
|
|
4152
|
+
> <Array(<ConversationPbxAudioResponse>, Integer, Hash)> get_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid)
|
|
4153
|
+
|
|
4154
|
+
```ruby
|
|
4155
|
+
begin
|
|
4156
|
+
# Get user pbx audio
|
|
4157
|
+
data, status_code, headers = api_instance.get_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid)
|
|
4158
|
+
p status_code # => 2xx
|
|
4159
|
+
p headers # => { ... }
|
|
4160
|
+
p data # => <ConversationPbxAudioResponse>
|
|
4161
|
+
rescue UltracartClient::ApiError => e
|
|
4162
|
+
puts "Error when calling ConversationApi->get_user_pbx_audio_with_http_info: #{e}"
|
|
4163
|
+
end
|
|
4164
|
+
```
|
|
4165
|
+
|
|
4166
|
+
### Parameters
|
|
4167
|
+
|
|
4168
|
+
| Name | Type | Description | Notes |
|
|
4169
|
+
| ---- | ---- | ----------- | ----- |
|
|
4170
|
+
| **conversation_pbx_audio_uuid** | **String** | | |
|
|
4171
|
+
|
|
4172
|
+
### Return type
|
|
4173
|
+
|
|
4174
|
+
[**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
|
|
4175
|
+
|
|
4176
|
+
### Authorization
|
|
4177
|
+
|
|
4178
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4179
|
+
|
|
4180
|
+
### HTTP request headers
|
|
4181
|
+
|
|
4182
|
+
- **Content-Type**: Not defined
|
|
4183
|
+
- **Accept**: application/json
|
|
4184
|
+
|
|
4185
|
+
|
|
4186
|
+
## get_user_pbx_audios
|
|
4187
|
+
|
|
4188
|
+
> <ConversationPbxAudiosResponse> get_user_pbx_audios
|
|
4189
|
+
|
|
4190
|
+
Get user pbx audios
|
|
4191
|
+
|
|
4192
|
+
Retrieve pbx audio files owned by the authenticated user
|
|
4193
|
+
|
|
4194
|
+
|
|
4195
|
+
### Examples
|
|
4196
|
+
|
|
4197
|
+
|
|
4198
|
+
(No example for this operation).
|
|
4199
|
+
|
|
4200
|
+
|
|
4201
|
+
#### Using the get_user_pbx_audios_with_http_info variant
|
|
4202
|
+
|
|
4203
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4204
|
+
|
|
4205
|
+
> <Array(<ConversationPbxAudiosResponse>, Integer, Hash)> get_user_pbx_audios_with_http_info
|
|
4206
|
+
|
|
4207
|
+
```ruby
|
|
4208
|
+
begin
|
|
4209
|
+
# Get user pbx audios
|
|
4210
|
+
data, status_code, headers = api_instance.get_user_pbx_audios_with_http_info
|
|
4211
|
+
p status_code # => 2xx
|
|
4212
|
+
p headers # => { ... }
|
|
4213
|
+
p data # => <ConversationPbxAudiosResponse>
|
|
4214
|
+
rescue UltracartClient::ApiError => e
|
|
4215
|
+
puts "Error when calling ConversationApi->get_user_pbx_audios_with_http_info: #{e}"
|
|
4216
|
+
end
|
|
4217
|
+
```
|
|
4218
|
+
|
|
4219
|
+
### Parameters
|
|
4220
|
+
|
|
4221
|
+
This endpoint does not need any parameter.
|
|
4222
|
+
|
|
4223
|
+
### Return type
|
|
4224
|
+
|
|
4225
|
+
[**ConversationPbxAudiosResponse**](ConversationPbxAudiosResponse.md)
|
|
4226
|
+
|
|
4227
|
+
### Authorization
|
|
4228
|
+
|
|
4229
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4230
|
+
|
|
4231
|
+
### HTTP request headers
|
|
4232
|
+
|
|
4233
|
+
- **Content-Type**: Not defined
|
|
4234
|
+
- **Accept**: application/json
|
|
4235
|
+
|
|
4236
|
+
|
|
4075
4237
|
## get_virtual_agent_budget
|
|
4076
4238
|
|
|
4077
4239
|
> <ConversationVirtualAgentBudgetResponse> get_virtual_agent_budget
|
|
@@ -4927,6 +5089,59 @@ end
|
|
|
4927
5089
|
- **Accept**: application/json
|
|
4928
5090
|
|
|
4929
5091
|
|
|
5092
|
+
## insert_user_pbx_audio
|
|
5093
|
+
|
|
5094
|
+
> <ConversationPbxAudioResponse> insert_user_pbx_audio(pbx_audio)
|
|
5095
|
+
|
|
5096
|
+
Insert user pbx audio
|
|
5097
|
+
|
|
5098
|
+
Insert a pbx audio file for the authenticated user
|
|
5099
|
+
|
|
5100
|
+
|
|
5101
|
+
### Examples
|
|
5102
|
+
|
|
5103
|
+
|
|
5104
|
+
(No example for this operation).
|
|
5105
|
+
|
|
5106
|
+
|
|
5107
|
+
#### Using the insert_user_pbx_audio_with_http_info variant
|
|
5108
|
+
|
|
5109
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5110
|
+
|
|
5111
|
+
> <Array(<ConversationPbxAudioResponse>, Integer, Hash)> insert_user_pbx_audio_with_http_info(pbx_audio)
|
|
5112
|
+
|
|
5113
|
+
```ruby
|
|
5114
|
+
begin
|
|
5115
|
+
# Insert user pbx audio
|
|
5116
|
+
data, status_code, headers = api_instance.insert_user_pbx_audio_with_http_info(pbx_audio)
|
|
5117
|
+
p status_code # => 2xx
|
|
5118
|
+
p headers # => { ... }
|
|
5119
|
+
p data # => <ConversationPbxAudioResponse>
|
|
5120
|
+
rescue UltracartClient::ApiError => e
|
|
5121
|
+
puts "Error when calling ConversationApi->insert_user_pbx_audio_with_http_info: #{e}"
|
|
5122
|
+
end
|
|
5123
|
+
```
|
|
5124
|
+
|
|
5125
|
+
### Parameters
|
|
5126
|
+
|
|
5127
|
+
| Name | Type | Description | Notes |
|
|
5128
|
+
| ---- | ---- | ----------- | ----- |
|
|
5129
|
+
| **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md) | Pbx Audio | |
|
|
5130
|
+
|
|
5131
|
+
### Return type
|
|
5132
|
+
|
|
5133
|
+
[**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
|
|
5134
|
+
|
|
5135
|
+
### Authorization
|
|
5136
|
+
|
|
5137
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5138
|
+
|
|
5139
|
+
### HTTP request headers
|
|
5140
|
+
|
|
5141
|
+
- **Content-Type**: application/json
|
|
5142
|
+
- **Accept**: application/json
|
|
5143
|
+
|
|
5144
|
+
|
|
4930
5145
|
## join_conversation
|
|
4931
5146
|
|
|
4932
5147
|
> join_conversation(conversation_uuid, opts)
|
|
@@ -6621,6 +6836,60 @@ end
|
|
|
6621
6836
|
- **Accept**: application/json
|
|
6622
6837
|
|
|
6623
6838
|
|
|
6839
|
+
## update_user_pbx_audio
|
|
6840
|
+
|
|
6841
|
+
> <ConversationPbxAudioResponse> update_user_pbx_audio(conversation_pbx_audio_uuid, pbx_audio)
|
|
6842
|
+
|
|
6843
|
+
Update user pbx audio
|
|
6844
|
+
|
|
6845
|
+
Update a pbx audio file owned by the authenticated user
|
|
6846
|
+
|
|
6847
|
+
|
|
6848
|
+
### Examples
|
|
6849
|
+
|
|
6850
|
+
|
|
6851
|
+
(No example for this operation).
|
|
6852
|
+
|
|
6853
|
+
|
|
6854
|
+
#### Using the update_user_pbx_audio_with_http_info variant
|
|
6855
|
+
|
|
6856
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6857
|
+
|
|
6858
|
+
> <Array(<ConversationPbxAudioResponse>, Integer, Hash)> update_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio)
|
|
6859
|
+
|
|
6860
|
+
```ruby
|
|
6861
|
+
begin
|
|
6862
|
+
# Update user pbx audio
|
|
6863
|
+
data, status_code, headers = api_instance.update_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio)
|
|
6864
|
+
p status_code # => 2xx
|
|
6865
|
+
p headers # => { ... }
|
|
6866
|
+
p data # => <ConversationPbxAudioResponse>
|
|
6867
|
+
rescue UltracartClient::ApiError => e
|
|
6868
|
+
puts "Error when calling ConversationApi->update_user_pbx_audio_with_http_info: #{e}"
|
|
6869
|
+
end
|
|
6870
|
+
```
|
|
6871
|
+
|
|
6872
|
+
### Parameters
|
|
6873
|
+
|
|
6874
|
+
| Name | Type | Description | Notes |
|
|
6875
|
+
| ---- | ---- | ----------- | ----- |
|
|
6876
|
+
| **conversation_pbx_audio_uuid** | **String** | | |
|
|
6877
|
+
| **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md) | Pbx Audio | |
|
|
6878
|
+
|
|
6879
|
+
### Return type
|
|
6880
|
+
|
|
6881
|
+
[**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
|
|
6882
|
+
|
|
6883
|
+
### Authorization
|
|
6884
|
+
|
|
6885
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6886
|
+
|
|
6887
|
+
### HTTP request headers
|
|
6888
|
+
|
|
6889
|
+
- **Content-Type**: application/json
|
|
6890
|
+
- **Accept**: application/json
|
|
6891
|
+
|
|
6892
|
+
|
|
6624
6893
|
## update_virtual_agent_budget
|
|
6625
6894
|
|
|
6626
6895
|
> <ConversationVirtualAgentBudgetResponse> update_virtual_agent_budget(virtual_agent_budget)
|
|
@@ -1138,6 +1138,70 @@ module UltracartClient
|
|
|
1138
1138
|
return data, status_code, headers
|
|
1139
1139
|
end
|
|
1140
1140
|
|
|
1141
|
+
# Delete user pbx audio
|
|
1142
|
+
# Delete a pbx audio file owned by the authenticated user
|
|
1143
|
+
# @param conversation_pbx_audio_uuid [String]
|
|
1144
|
+
# @param [Hash] opts the optional parameters
|
|
1145
|
+
# @return [ConversationPbxAudioResponse]
|
|
1146
|
+
def delete_user_pbx_audio(conversation_pbx_audio_uuid, opts = {})
|
|
1147
|
+
data, _status_code, _headers = delete_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts)
|
|
1148
|
+
data
|
|
1149
|
+
end
|
|
1150
|
+
|
|
1151
|
+
# Delete user pbx audio
|
|
1152
|
+
# Delete a pbx audio file owned by the authenticated user
|
|
1153
|
+
# @param conversation_pbx_audio_uuid [String]
|
|
1154
|
+
# @param [Hash] opts the optional parameters
|
|
1155
|
+
# @return [Array<(ConversationPbxAudioResponse, Integer, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
|
|
1156
|
+
def delete_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts = {})
|
|
1157
|
+
if @api_client.config.debugging
|
|
1158
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_user_pbx_audio ...'
|
|
1159
|
+
end
|
|
1160
|
+
# verify the required parameter 'conversation_pbx_audio_uuid' is set
|
|
1161
|
+
if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
|
|
1162
|
+
fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.delete_user_pbx_audio"
|
|
1163
|
+
end
|
|
1164
|
+
# resource path
|
|
1165
|
+
local_var_path = '/conversation/pbx/audio/user/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', CGI.escape(conversation_pbx_audio_uuid.to_s))
|
|
1166
|
+
|
|
1167
|
+
# query parameters
|
|
1168
|
+
query_params = opts[:query_params] || {}
|
|
1169
|
+
|
|
1170
|
+
# header parameters
|
|
1171
|
+
header_params = opts[:header_params] || {}
|
|
1172
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1173
|
+
# HTTP header 'Accept' (if needed)
|
|
1174
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1175
|
+
|
|
1176
|
+
# form parameters
|
|
1177
|
+
form_params = opts[:form_params] || {}
|
|
1178
|
+
|
|
1179
|
+
# http body (model)
|
|
1180
|
+
post_body = opts[:debug_body]
|
|
1181
|
+
|
|
1182
|
+
# return_type
|
|
1183
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxAudioResponse'
|
|
1184
|
+
|
|
1185
|
+
# auth_names
|
|
1186
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1187
|
+
|
|
1188
|
+
new_options = opts.merge(
|
|
1189
|
+
:operation => :"ConversationApi.delete_user_pbx_audio",
|
|
1190
|
+
:header_params => header_params,
|
|
1191
|
+
:query_params => query_params,
|
|
1192
|
+
:form_params => form_params,
|
|
1193
|
+
:body => post_body,
|
|
1194
|
+
:auth_names => auth_names,
|
|
1195
|
+
:return_type => return_type
|
|
1196
|
+
)
|
|
1197
|
+
|
|
1198
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1199
|
+
if @api_client.config.debugging
|
|
1200
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_user_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1201
|
+
end
|
|
1202
|
+
return data, status_code, headers
|
|
1203
|
+
end
|
|
1204
|
+
|
|
1141
1205
|
# Agent keep alive
|
|
1142
1206
|
# Called periodically by the conversation API to keep the session alive.
|
|
1143
1207
|
# @param [Hash] opts the optional parameters
|
|
@@ -4705,6 +4769,128 @@ module UltracartClient
|
|
|
4705
4769
|
return data, status_code, headers
|
|
4706
4770
|
end
|
|
4707
4771
|
|
|
4772
|
+
# Get user pbx audio
|
|
4773
|
+
# Retrieve a pbx audio file owned by the authenticated user
|
|
4774
|
+
# @param conversation_pbx_audio_uuid [String]
|
|
4775
|
+
# @param [Hash] opts the optional parameters
|
|
4776
|
+
# @return [ConversationPbxAudioResponse]
|
|
4777
|
+
def get_user_pbx_audio(conversation_pbx_audio_uuid, opts = {})
|
|
4778
|
+
data, _status_code, _headers = get_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts)
|
|
4779
|
+
data
|
|
4780
|
+
end
|
|
4781
|
+
|
|
4782
|
+
# Get user pbx audio
|
|
4783
|
+
# Retrieve a pbx audio file owned by the authenticated user
|
|
4784
|
+
# @param conversation_pbx_audio_uuid [String]
|
|
4785
|
+
# @param [Hash] opts the optional parameters
|
|
4786
|
+
# @return [Array<(ConversationPbxAudioResponse, Integer, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
|
|
4787
|
+
def get_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts = {})
|
|
4788
|
+
if @api_client.config.debugging
|
|
4789
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_user_pbx_audio ...'
|
|
4790
|
+
end
|
|
4791
|
+
# verify the required parameter 'conversation_pbx_audio_uuid' is set
|
|
4792
|
+
if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
|
|
4793
|
+
fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.get_user_pbx_audio"
|
|
4794
|
+
end
|
|
4795
|
+
# resource path
|
|
4796
|
+
local_var_path = '/conversation/pbx/audio/user/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', CGI.escape(conversation_pbx_audio_uuid.to_s))
|
|
4797
|
+
|
|
4798
|
+
# query parameters
|
|
4799
|
+
query_params = opts[:query_params] || {}
|
|
4800
|
+
|
|
4801
|
+
# header parameters
|
|
4802
|
+
header_params = opts[:header_params] || {}
|
|
4803
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4804
|
+
# HTTP header 'Accept' (if needed)
|
|
4805
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4806
|
+
|
|
4807
|
+
# form parameters
|
|
4808
|
+
form_params = opts[:form_params] || {}
|
|
4809
|
+
|
|
4810
|
+
# http body (model)
|
|
4811
|
+
post_body = opts[:debug_body]
|
|
4812
|
+
|
|
4813
|
+
# return_type
|
|
4814
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxAudioResponse'
|
|
4815
|
+
|
|
4816
|
+
# auth_names
|
|
4817
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4818
|
+
|
|
4819
|
+
new_options = opts.merge(
|
|
4820
|
+
:operation => :"ConversationApi.get_user_pbx_audio",
|
|
4821
|
+
:header_params => header_params,
|
|
4822
|
+
:query_params => query_params,
|
|
4823
|
+
:form_params => form_params,
|
|
4824
|
+
:body => post_body,
|
|
4825
|
+
:auth_names => auth_names,
|
|
4826
|
+
:return_type => return_type
|
|
4827
|
+
)
|
|
4828
|
+
|
|
4829
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4830
|
+
if @api_client.config.debugging
|
|
4831
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_user_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4832
|
+
end
|
|
4833
|
+
return data, status_code, headers
|
|
4834
|
+
end
|
|
4835
|
+
|
|
4836
|
+
# Get user pbx audios
|
|
4837
|
+
# Retrieve pbx audio files owned by the authenticated user
|
|
4838
|
+
# @param [Hash] opts the optional parameters
|
|
4839
|
+
# @return [ConversationPbxAudiosResponse]
|
|
4840
|
+
def get_user_pbx_audios(opts = {})
|
|
4841
|
+
data, _status_code, _headers = get_user_pbx_audios_with_http_info(opts)
|
|
4842
|
+
data
|
|
4843
|
+
end
|
|
4844
|
+
|
|
4845
|
+
# Get user pbx audios
|
|
4846
|
+
# Retrieve pbx audio files owned by the authenticated user
|
|
4847
|
+
# @param [Hash] opts the optional parameters
|
|
4848
|
+
# @return [Array<(ConversationPbxAudiosResponse, Integer, Hash)>] ConversationPbxAudiosResponse data, response status code and response headers
|
|
4849
|
+
def get_user_pbx_audios_with_http_info(opts = {})
|
|
4850
|
+
if @api_client.config.debugging
|
|
4851
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_user_pbx_audios ...'
|
|
4852
|
+
end
|
|
4853
|
+
# resource path
|
|
4854
|
+
local_var_path = '/conversation/pbx/audio/user'
|
|
4855
|
+
|
|
4856
|
+
# query parameters
|
|
4857
|
+
query_params = opts[:query_params] || {}
|
|
4858
|
+
|
|
4859
|
+
# header parameters
|
|
4860
|
+
header_params = opts[:header_params] || {}
|
|
4861
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4862
|
+
# HTTP header 'Accept' (if needed)
|
|
4863
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4864
|
+
|
|
4865
|
+
# form parameters
|
|
4866
|
+
form_params = opts[:form_params] || {}
|
|
4867
|
+
|
|
4868
|
+
# http body (model)
|
|
4869
|
+
post_body = opts[:debug_body]
|
|
4870
|
+
|
|
4871
|
+
# return_type
|
|
4872
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxAudiosResponse'
|
|
4873
|
+
|
|
4874
|
+
# auth_names
|
|
4875
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4876
|
+
|
|
4877
|
+
new_options = opts.merge(
|
|
4878
|
+
:operation => :"ConversationApi.get_user_pbx_audios",
|
|
4879
|
+
:header_params => header_params,
|
|
4880
|
+
:query_params => query_params,
|
|
4881
|
+
:form_params => form_params,
|
|
4882
|
+
:body => post_body,
|
|
4883
|
+
:auth_names => auth_names,
|
|
4884
|
+
:return_type => return_type
|
|
4885
|
+
)
|
|
4886
|
+
|
|
4887
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4888
|
+
if @api_client.config.debugging
|
|
4889
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_user_pbx_audios\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4890
|
+
end
|
|
4891
|
+
return data, status_code, headers
|
|
4892
|
+
end
|
|
4893
|
+
|
|
4708
4894
|
# Get virtual agent budget
|
|
4709
4895
|
# Retrieve virtual agent budget
|
|
4710
4896
|
# @param [Hash] opts the optional parameters
|
|
@@ -5799,6 +5985,75 @@ module UltracartClient
|
|
|
5799
5985
|
return data, status_code, headers
|
|
5800
5986
|
end
|
|
5801
5987
|
|
|
5988
|
+
# Insert user pbx audio
|
|
5989
|
+
# Insert a pbx audio file for the authenticated user
|
|
5990
|
+
# @param pbx_audio [ConversationPbxAudio] Pbx Audio
|
|
5991
|
+
# @param [Hash] opts the optional parameters
|
|
5992
|
+
# @return [ConversationPbxAudioResponse]
|
|
5993
|
+
def insert_user_pbx_audio(pbx_audio, opts = {})
|
|
5994
|
+
data, _status_code, _headers = insert_user_pbx_audio_with_http_info(pbx_audio, opts)
|
|
5995
|
+
data
|
|
5996
|
+
end
|
|
5997
|
+
|
|
5998
|
+
# Insert user pbx audio
|
|
5999
|
+
# Insert a pbx audio file for the authenticated user
|
|
6000
|
+
# @param pbx_audio [ConversationPbxAudio] Pbx Audio
|
|
6001
|
+
# @param [Hash] opts the optional parameters
|
|
6002
|
+
# @return [Array<(ConversationPbxAudioResponse, Integer, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
|
|
6003
|
+
def insert_user_pbx_audio_with_http_info(pbx_audio, opts = {})
|
|
6004
|
+
if @api_client.config.debugging
|
|
6005
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.insert_user_pbx_audio ...'
|
|
6006
|
+
end
|
|
6007
|
+
# verify the required parameter 'pbx_audio' is set
|
|
6008
|
+
if @api_client.config.client_side_validation && pbx_audio.nil?
|
|
6009
|
+
fail ArgumentError, "Missing the required parameter 'pbx_audio' when calling ConversationApi.insert_user_pbx_audio"
|
|
6010
|
+
end
|
|
6011
|
+
# resource path
|
|
6012
|
+
local_var_path = '/conversation/pbx/audio/user'
|
|
6013
|
+
|
|
6014
|
+
# query parameters
|
|
6015
|
+
query_params = opts[:query_params] || {}
|
|
6016
|
+
|
|
6017
|
+
# header parameters
|
|
6018
|
+
header_params = opts[:header_params] || {}
|
|
6019
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
6020
|
+
# HTTP header 'Accept' (if needed)
|
|
6021
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
6022
|
+
# HTTP header 'Content-Type'
|
|
6023
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
6024
|
+
if !content_type.nil?
|
|
6025
|
+
header_params['Content-Type'] = content_type
|
|
6026
|
+
end
|
|
6027
|
+
|
|
6028
|
+
# form parameters
|
|
6029
|
+
form_params = opts[:form_params] || {}
|
|
6030
|
+
|
|
6031
|
+
# http body (model)
|
|
6032
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(pbx_audio)
|
|
6033
|
+
|
|
6034
|
+
# return_type
|
|
6035
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxAudioResponse'
|
|
6036
|
+
|
|
6037
|
+
# auth_names
|
|
6038
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
6039
|
+
|
|
6040
|
+
new_options = opts.merge(
|
|
6041
|
+
:operation => :"ConversationApi.insert_user_pbx_audio",
|
|
6042
|
+
:header_params => header_params,
|
|
6043
|
+
:query_params => query_params,
|
|
6044
|
+
:form_params => form_params,
|
|
6045
|
+
:body => post_body,
|
|
6046
|
+
:auth_names => auth_names,
|
|
6047
|
+
:return_type => return_type
|
|
6048
|
+
)
|
|
6049
|
+
|
|
6050
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
6051
|
+
if @api_client.config.debugging
|
|
6052
|
+
@api_client.config.logger.debug "API called: ConversationApi#insert_user_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6053
|
+
end
|
|
6054
|
+
return data, status_code, headers
|
|
6055
|
+
end
|
|
6056
|
+
|
|
5802
6057
|
# Join a conversation
|
|
5803
6058
|
# Join a conversation
|
|
5804
6059
|
# @param conversation_uuid [String]
|
|
@@ -8042,6 +8297,81 @@ module UltracartClient
|
|
|
8042
8297
|
return data, status_code, headers
|
|
8043
8298
|
end
|
|
8044
8299
|
|
|
8300
|
+
# Update user pbx audio
|
|
8301
|
+
# Update a pbx audio file owned by the authenticated user
|
|
8302
|
+
# @param conversation_pbx_audio_uuid [String]
|
|
8303
|
+
# @param pbx_audio [ConversationPbxAudio] Pbx Audio
|
|
8304
|
+
# @param [Hash] opts the optional parameters
|
|
8305
|
+
# @return [ConversationPbxAudioResponse]
|
|
8306
|
+
def update_user_pbx_audio(conversation_pbx_audio_uuid, pbx_audio, opts = {})
|
|
8307
|
+
data, _status_code, _headers = update_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio, opts)
|
|
8308
|
+
data
|
|
8309
|
+
end
|
|
8310
|
+
|
|
8311
|
+
# Update user pbx audio
|
|
8312
|
+
# Update a pbx audio file owned by the authenticated user
|
|
8313
|
+
# @param conversation_pbx_audio_uuid [String]
|
|
8314
|
+
# @param pbx_audio [ConversationPbxAudio] Pbx Audio
|
|
8315
|
+
# @param [Hash] opts the optional parameters
|
|
8316
|
+
# @return [Array<(ConversationPbxAudioResponse, Integer, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
|
|
8317
|
+
def update_user_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio, opts = {})
|
|
8318
|
+
if @api_client.config.debugging
|
|
8319
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_user_pbx_audio ...'
|
|
8320
|
+
end
|
|
8321
|
+
# verify the required parameter 'conversation_pbx_audio_uuid' is set
|
|
8322
|
+
if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
|
|
8323
|
+
fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.update_user_pbx_audio"
|
|
8324
|
+
end
|
|
8325
|
+
# verify the required parameter 'pbx_audio' is set
|
|
8326
|
+
if @api_client.config.client_side_validation && pbx_audio.nil?
|
|
8327
|
+
fail ArgumentError, "Missing the required parameter 'pbx_audio' when calling ConversationApi.update_user_pbx_audio"
|
|
8328
|
+
end
|
|
8329
|
+
# resource path
|
|
8330
|
+
local_var_path = '/conversation/pbx/audio/user/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', CGI.escape(conversation_pbx_audio_uuid.to_s))
|
|
8331
|
+
|
|
8332
|
+
# query parameters
|
|
8333
|
+
query_params = opts[:query_params] || {}
|
|
8334
|
+
|
|
8335
|
+
# header parameters
|
|
8336
|
+
header_params = opts[:header_params] || {}
|
|
8337
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
8338
|
+
# HTTP header 'Accept' (if needed)
|
|
8339
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
8340
|
+
# HTTP header 'Content-Type'
|
|
8341
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
8342
|
+
if !content_type.nil?
|
|
8343
|
+
header_params['Content-Type'] = content_type
|
|
8344
|
+
end
|
|
8345
|
+
|
|
8346
|
+
# form parameters
|
|
8347
|
+
form_params = opts[:form_params] || {}
|
|
8348
|
+
|
|
8349
|
+
# http body (model)
|
|
8350
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(pbx_audio)
|
|
8351
|
+
|
|
8352
|
+
# return_type
|
|
8353
|
+
return_type = opts[:debug_return_type] || 'ConversationPbxAudioResponse'
|
|
8354
|
+
|
|
8355
|
+
# auth_names
|
|
8356
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
8357
|
+
|
|
8358
|
+
new_options = opts.merge(
|
|
8359
|
+
:operation => :"ConversationApi.update_user_pbx_audio",
|
|
8360
|
+
:header_params => header_params,
|
|
8361
|
+
:query_params => query_params,
|
|
8362
|
+
:form_params => form_params,
|
|
8363
|
+
:body => post_body,
|
|
8364
|
+
:auth_names => auth_names,
|
|
8365
|
+
:return_type => return_type
|
|
8366
|
+
)
|
|
8367
|
+
|
|
8368
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
8369
|
+
if @api_client.config.debugging
|
|
8370
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_user_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
8371
|
+
end
|
|
8372
|
+
return data, status_code, headers
|
|
8373
|
+
end
|
|
8374
|
+
|
|
8045
8375
|
# Update virtual agent budget
|
|
8046
8376
|
# Update virtual agent budget
|
|
8047
8377
|
# @param virtual_agent_budget [ConversationVirtualAgentBudget] Virtual Agent Budget
|