ultracart_api 3.11.55 → 3.11.57
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 +17 -4
- data/docs/ConversationAgentAuth.md +1 -0
- data/docs/ConversationApi.md +309 -0
- data/docs/ConversationPbxAgent.md +1 -0
- data/docs/ConversationPbxCallRecording.md +1 -0
- data/docs/ConversationPbxClassOfService.md +16 -0
- data/docs/ConversationPbxClassOfServiceResponse.md +12 -0
- data/docs/ConversationPbxClassOfServicesResponse.md +12 -0
- data/docs/ConversationPbxCosAuditLog.md +17 -0
- data/docs/ConversationPbxCosAuditLogsResponse.md +12 -0
- data/docs/Twilio.md +1 -0
- data/lib/ultracart_api/api/conversation_api.rb +333 -0
- data/lib/ultracart_api/models/conversation_agent_auth.rb +11 -1
- data/lib/ultracart_api/models/conversation_pbx_agent.rb +18 -6
- data/lib/ultracart_api/models/conversation_pbx_call_recording.rb +11 -1
- data/lib/ultracart_api/models/conversation_pbx_class_of_service.rb +312 -0
- data/lib/ultracart_api/models/conversation_pbx_class_of_service_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_pbx_class_of_services_response.rb +224 -0
- data/lib/ultracart_api/models/conversation_pbx_cos_audit_log.rb +336 -0
- data/lib/ultracart_api/models/conversation_pbx_cos_audit_logs_response.rb +224 -0
- data/lib/ultracart_api/models/conversation_pbx_queue.rb +14 -10
- data/lib/ultracart_api/models/twilio.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 725ca91c0dd7cf015731d6e9c17e9c9fdcb2a4afb6e926367a2297abf23fe821
|
|
4
|
+
data.tar.gz: c184dd0263f729eeb4691252cda7cb533d63912dcbc8a8c57aea0c7809d93e89
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2ef7f3eb26fc189b3b569e5e8af066f899edc641fa783fd5e8785c80940ddeaadfc9c72ba7d5805fdf13ea45ed4567fb4017e826da4c18b1f53502ec262fce48
|
|
7
|
+
data.tar.gz: 7f58cffeaaf7b564db7b12c22e11ef018d67c0cb13a6230920d4760d12dd67212d0db1806b01836f07d4dc4fae358acbf5f2ae3b1414aebef4a97fd88093fe01
|
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.11.
|
|
10
|
+
- Package version: 3.11.57
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
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.11.
|
|
27
|
+
gem install ./ultracart_api-3.11.57.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.11.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.11.57.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.11.
|
|
35
|
+
gem 'ultracart_api', '~> 3.11.57'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -141,6 +141,7 @@ Class | Method | HTTP request | Description
|
|
|
141
141
|
*UltracartClient::ConversationApi* | [**delete_pbx_address**](docs/ConversationApi.md#delete_pbx_address) | **DELETE** /conversation/pbx/address/{conversationPbxAddressUuid} | Delete pbx address
|
|
142
142
|
*UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
|
|
143
143
|
*UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
|
|
144
|
+
*UltracartClient::ConversationApi* | [**delete_pbx_class_of_service**](docs/ConversationApi.md#delete_pbx_class_of_service) | **DELETE** /conversation/pbx/class_of_service/{classOfServiceUuid} | Delete pbx class of service
|
|
144
145
|
*UltracartClient::ConversationApi* | [**delete_pbx_hardware_phone**](docs/ConversationApi.md#delete_pbx_hardware_phone) | **DELETE** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Delete pbx hardware phone
|
|
145
146
|
*UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
|
|
146
147
|
*UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
|
|
@@ -185,6 +186,9 @@ Class | Method | HTTP request | Description
|
|
|
185
186
|
*UltracartClient::ConversationApi* | [**get_pbx_audio_usage**](docs/ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
|
|
186
187
|
*UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
|
|
187
188
|
*UltracartClient::ConversationApi* | [**get_pbx_call**](docs/ConversationApi.md#get_pbx_call) | **GET** /conversation/pbx/call/{callUuid} | Get pbx call record
|
|
189
|
+
*UltracartClient::ConversationApi* | [**get_pbx_class_of_service**](docs/ConversationApi.md#get_pbx_class_of_service) | **GET** /conversation/pbx/class_of_service/{classOfServiceUuid} | Get pbx class of service
|
|
190
|
+
*UltracartClient::ConversationApi* | [**get_pbx_classes_of_service**](docs/ConversationApi.md#get_pbx_classes_of_service) | **GET** /conversation/pbx/class_of_service | Get pbx classes of service
|
|
191
|
+
*UltracartClient::ConversationApi* | [**get_pbx_cos_audit_logs**](docs/ConversationApi.md#get_pbx_cos_audit_logs) | **GET** /conversation/pbx/class_of_service/audit_log | Get pbx class of service audit logs
|
|
188
192
|
*UltracartClient::ConversationApi* | [**get_pbx_hardware_phone**](docs/ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone
|
|
189
193
|
*UltracartClient::ConversationApi* | [**get_pbx_hardware_phone_manufacturers**](docs/ConversationApi.md#get_pbx_hardware_phone_manufacturers) | **GET** /conversation/pbx/hardware_phone/manufacturers | Get pbx hardware phone manufacturers
|
|
190
194
|
*UltracartClient::ConversationApi* | [**get_pbx_hardware_phones**](docs/ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
|
|
@@ -211,6 +215,7 @@ Class | Method | HTTP request | Description
|
|
|
211
215
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
|
212
216
|
*UltracartClient::ConversationApi* | [**insert_pbx_address**](docs/ConversationApi.md#insert_pbx_address) | **POST** /conversation/pbx/address | Insert pbx address
|
|
213
217
|
*UltracartClient::ConversationApi* | [**insert_pbx_audio**](docs/ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
|
|
218
|
+
*UltracartClient::ConversationApi* | [**insert_pbx_class_of_service**](docs/ConversationApi.md#insert_pbx_class_of_service) | **POST** /conversation/pbx/class_of_service | Insert pbx class of service
|
|
214
219
|
*UltracartClient::ConversationApi* | [**insert_pbx_hardware_phone**](docs/ConversationApi.md#insert_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone | Insert pbx hardware phone
|
|
215
220
|
*UltracartClient::ConversationApi* | [**insert_pbx_menu**](docs/ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
|
|
216
221
|
*UltracartClient::ConversationApi* | [**insert_pbx_queue**](docs/ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
|
|
@@ -240,6 +245,7 @@ Class | Method | HTTP request | Description
|
|
|
240
245
|
*UltracartClient::ConversationApi* | [**update_pbx_address**](docs/ConversationApi.md#update_pbx_address) | **PUT** /conversation/pbx/address/{conversationPbxAddressUuid} | Update pbx address
|
|
241
246
|
*UltracartClient::ConversationApi* | [**update_pbx_agent**](docs/ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
|
|
242
247
|
*UltracartClient::ConversationApi* | [**update_pbx_audio**](docs/ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
|
|
248
|
+
*UltracartClient::ConversationApi* | [**update_pbx_class_of_service**](docs/ConversationApi.md#update_pbx_class_of_service) | **PUT** /conversation/pbx/class_of_service/{classOfServiceUuid} | Update pbx class of service
|
|
243
249
|
*UltracartClient::ConversationApi* | [**update_pbx_hardware_phone**](docs/ConversationApi.md#update_pbx_hardware_phone) | **PUT** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Update pbx hardware phone
|
|
244
250
|
*UltracartClient::ConversationApi* | [**update_pbx_menu**](docs/ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
|
|
245
251
|
*UltracartClient::ConversationApi* | [**update_pbx_phone_number**](docs/ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
|
|
@@ -862,6 +868,11 @@ Class | Method | HTTP request | Description
|
|
|
862
868
|
- [UltracartClient::ConversationPbxCallTranscript](docs/ConversationPbxCallTranscript.md)
|
|
863
869
|
- [UltracartClient::ConversationPbxCallTranscriptSegment](docs/ConversationPbxCallTranscriptSegment.md)
|
|
864
870
|
- [UltracartClient::ConversationPbxCallTransfer](docs/ConversationPbxCallTransfer.md)
|
|
871
|
+
- [UltracartClient::ConversationPbxClassOfService](docs/ConversationPbxClassOfService.md)
|
|
872
|
+
- [UltracartClient::ConversationPbxClassOfServiceResponse](docs/ConversationPbxClassOfServiceResponse.md)
|
|
873
|
+
- [UltracartClient::ConversationPbxClassOfServicesResponse](docs/ConversationPbxClassOfServicesResponse.md)
|
|
874
|
+
- [UltracartClient::ConversationPbxCosAuditLog](docs/ConversationPbxCosAuditLog.md)
|
|
875
|
+
- [UltracartClient::ConversationPbxCosAuditLogsResponse](docs/ConversationPbxCosAuditLogsResponse.md)
|
|
865
876
|
- [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
|
|
866
877
|
- [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
|
|
867
878
|
- [UltracartClient::ConversationPbxHardwarePhone](docs/ConversationPbxHardwarePhone.md)
|
|
@@ -1658,6 +1669,8 @@ Not every change is committed to every SDK.
|
|
|
1658
1669
|
|
|
1659
1670
|
| Version | Date | Comments |
|
|
1660
1671
|
| --: | :-: | --- |
|
|
1672
|
+
| 3.11.57 | 02/03/2026 | conversations - pbx class of service objects and endpoints |
|
|
1673
|
+
| 3.11.56 | 02/02/2026 | conversations - add default phone number to the agent auth |
|
|
1661
1674
|
| 3.11.55 | 02/02/2026 | conversations - add enumerated values for say voice on queue and agent |
|
|
1662
1675
|
| 3.11.54 | 02/02/2026 | build error fix |
|
|
1663
1676
|
| 3.11.53 | 02/02/2026 | conversations default pricing phone number settings |
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**chat_user** | **BOOLEAN** | | [optional]
|
|
8
8
|
**conversation_participant_arn** | **String** | | [optional]
|
|
9
9
|
**conversation_participant_name** | **String** | | [optional]
|
|
10
|
+
**default_phone_number** | **String** | The default phone number this agent should use when making an outbound call. | [optional]
|
|
10
11
|
**group_ids** | **Array<Integer>** | UltraCart Groups this user belongs to | [optional]
|
|
11
12
|
**jwt** | **String** | | [optional]
|
|
12
13
|
**merchant_id** | **String** | | [optional]
|
data/docs/ConversationApi.md
CHANGED
|
@@ -12,6 +12,7 @@ Method | HTTP request | Description
|
|
|
12
12
|
[**delete_pbx_address**](ConversationApi.md#delete_pbx_address) | **DELETE** /conversation/pbx/address/{conversationPbxAddressUuid} | Delete pbx address
|
|
13
13
|
[**delete_pbx_agent_voicemail**](ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
|
|
14
14
|
[**delete_pbx_audio**](ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
|
|
15
|
+
[**delete_pbx_class_of_service**](ConversationApi.md#delete_pbx_class_of_service) | **DELETE** /conversation/pbx/class_of_service/{classOfServiceUuid} | Delete pbx class of service
|
|
15
16
|
[**delete_pbx_hardware_phone**](ConversationApi.md#delete_pbx_hardware_phone) | **DELETE** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Delete pbx hardware phone
|
|
16
17
|
[**delete_pbx_menu**](ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
|
|
17
18
|
[**delete_pbx_phone_number**](ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
|
|
@@ -56,6 +57,9 @@ Method | HTTP request | Description
|
|
|
56
57
|
[**get_pbx_audio_usage**](ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
|
|
57
58
|
[**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
|
|
58
59
|
[**get_pbx_call**](ConversationApi.md#get_pbx_call) | **GET** /conversation/pbx/call/{callUuid} | Get pbx call record
|
|
60
|
+
[**get_pbx_class_of_service**](ConversationApi.md#get_pbx_class_of_service) | **GET** /conversation/pbx/class_of_service/{classOfServiceUuid} | Get pbx class of service
|
|
61
|
+
[**get_pbx_classes_of_service**](ConversationApi.md#get_pbx_classes_of_service) | **GET** /conversation/pbx/class_of_service | Get pbx classes of service
|
|
62
|
+
[**get_pbx_cos_audit_logs**](ConversationApi.md#get_pbx_cos_audit_logs) | **GET** /conversation/pbx/class_of_service/audit_log | Get pbx class of service audit logs
|
|
59
63
|
[**get_pbx_hardware_phone**](ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone
|
|
60
64
|
[**get_pbx_hardware_phone_manufacturers**](ConversationApi.md#get_pbx_hardware_phone_manufacturers) | **GET** /conversation/pbx/hardware_phone/manufacturers | Get pbx hardware phone manufacturers
|
|
61
65
|
[**get_pbx_hardware_phones**](ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
|
|
@@ -82,6 +86,7 @@ Method | HTTP request | Description
|
|
|
82
86
|
[**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
|
83
87
|
[**insert_pbx_address**](ConversationApi.md#insert_pbx_address) | **POST** /conversation/pbx/address | Insert pbx address
|
|
84
88
|
[**insert_pbx_audio**](ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
|
|
89
|
+
[**insert_pbx_class_of_service**](ConversationApi.md#insert_pbx_class_of_service) | **POST** /conversation/pbx/class_of_service | Insert pbx class of service
|
|
85
90
|
[**insert_pbx_hardware_phone**](ConversationApi.md#insert_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone | Insert pbx hardware phone
|
|
86
91
|
[**insert_pbx_menu**](ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
|
|
87
92
|
[**insert_pbx_queue**](ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
|
|
@@ -111,6 +116,7 @@ Method | HTTP request | Description
|
|
|
111
116
|
[**update_pbx_address**](ConversationApi.md#update_pbx_address) | **PUT** /conversation/pbx/address/{conversationPbxAddressUuid} | Update pbx address
|
|
112
117
|
[**update_pbx_agent**](ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
|
|
113
118
|
[**update_pbx_audio**](ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
|
|
119
|
+
[**update_pbx_class_of_service**](ConversationApi.md#update_pbx_class_of_service) | **PUT** /conversation/pbx/class_of_service/{classOfServiceUuid} | Update pbx class of service
|
|
114
120
|
[**update_pbx_hardware_phone**](ConversationApi.md#update_pbx_hardware_phone) | **PUT** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Update pbx hardware phone
|
|
115
121
|
[**update_pbx_menu**](ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
|
|
116
122
|
[**update_pbx_phone_number**](ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
|
|
@@ -523,6 +529,56 @@ Name | Type | Description | Notes
|
|
|
523
529
|
|
|
524
530
|
|
|
525
531
|
|
|
532
|
+
# **delete_pbx_class_of_service**
|
|
533
|
+
> BaseResponse delete_pbx_class_of_service(class_of_service_uuid)
|
|
534
|
+
|
|
535
|
+
Delete pbx class of service
|
|
536
|
+
|
|
537
|
+
Delete a class of service
|
|
538
|
+
|
|
539
|
+
### Example
|
|
540
|
+
```ruby
|
|
541
|
+
# load the gem
|
|
542
|
+
require 'ultracart_api'
|
|
543
|
+
|
|
544
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
545
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
546
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
class_of_service_uuid = 'class_of_service_uuid_example' # String |
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
begin
|
|
553
|
+
#Delete pbx class of service
|
|
554
|
+
result = api_instance.delete_pbx_class_of_service(class_of_service_uuid)
|
|
555
|
+
p result
|
|
556
|
+
rescue UltracartClient::ApiError => e
|
|
557
|
+
puts "Exception when calling ConversationApi->delete_pbx_class_of_service: #{e}"
|
|
558
|
+
end
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
### Parameters
|
|
562
|
+
|
|
563
|
+
Name | Type | Description | Notes
|
|
564
|
+
------------- | ------------- | ------------- | -------------
|
|
565
|
+
**class_of_service_uuid** | **String**| |
|
|
566
|
+
|
|
567
|
+
### Return type
|
|
568
|
+
|
|
569
|
+
[**BaseResponse**](BaseResponse.md)
|
|
570
|
+
|
|
571
|
+
### Authorization
|
|
572
|
+
|
|
573
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
574
|
+
|
|
575
|
+
### HTTP request headers
|
|
576
|
+
|
|
577
|
+
- **Content-Type**: application/json
|
|
578
|
+
- **Accept**: application/json
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
526
582
|
# **delete_pbx_hardware_phone**
|
|
527
583
|
> ConversationPbxHardwarePhoneResponse delete_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
|
|
528
584
|
|
|
@@ -2675,6 +2731,156 @@ Name | Type | Description | Notes
|
|
|
2675
2731
|
|
|
2676
2732
|
|
|
2677
2733
|
|
|
2734
|
+
# **get_pbx_class_of_service**
|
|
2735
|
+
> ConversationPbxClassOfServiceResponse get_pbx_class_of_service(class_of_service_uuid)
|
|
2736
|
+
|
|
2737
|
+
Get pbx class of service
|
|
2738
|
+
|
|
2739
|
+
Retrieve a single class of service
|
|
2740
|
+
|
|
2741
|
+
### Example
|
|
2742
|
+
```ruby
|
|
2743
|
+
# load the gem
|
|
2744
|
+
require 'ultracart_api'
|
|
2745
|
+
|
|
2746
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
2747
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
2748
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
2749
|
+
|
|
2750
|
+
|
|
2751
|
+
class_of_service_uuid = 'class_of_service_uuid_example' # String |
|
|
2752
|
+
|
|
2753
|
+
|
|
2754
|
+
begin
|
|
2755
|
+
#Get pbx class of service
|
|
2756
|
+
result = api_instance.get_pbx_class_of_service(class_of_service_uuid)
|
|
2757
|
+
p result
|
|
2758
|
+
rescue UltracartClient::ApiError => e
|
|
2759
|
+
puts "Exception when calling ConversationApi->get_pbx_class_of_service: #{e}"
|
|
2760
|
+
end
|
|
2761
|
+
```
|
|
2762
|
+
|
|
2763
|
+
### Parameters
|
|
2764
|
+
|
|
2765
|
+
Name | Type | Description | Notes
|
|
2766
|
+
------------- | ------------- | ------------- | -------------
|
|
2767
|
+
**class_of_service_uuid** | **String**| |
|
|
2768
|
+
|
|
2769
|
+
### Return type
|
|
2770
|
+
|
|
2771
|
+
[**ConversationPbxClassOfServiceResponse**](ConversationPbxClassOfServiceResponse.md)
|
|
2772
|
+
|
|
2773
|
+
### Authorization
|
|
2774
|
+
|
|
2775
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2776
|
+
|
|
2777
|
+
### HTTP request headers
|
|
2778
|
+
|
|
2779
|
+
- **Content-Type**: application/json
|
|
2780
|
+
- **Accept**: application/json
|
|
2781
|
+
|
|
2782
|
+
|
|
2783
|
+
|
|
2784
|
+
# **get_pbx_classes_of_service**
|
|
2785
|
+
> ConversationPbxClassOfServicesResponse get_pbx_classes_of_service
|
|
2786
|
+
|
|
2787
|
+
Get pbx classes of service
|
|
2788
|
+
|
|
2789
|
+
Retrieve all classes of service for the merchant
|
|
2790
|
+
|
|
2791
|
+
### Example
|
|
2792
|
+
```ruby
|
|
2793
|
+
# load the gem
|
|
2794
|
+
require 'ultracart_api'
|
|
2795
|
+
|
|
2796
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
2797
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
2798
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
2799
|
+
|
|
2800
|
+
|
|
2801
|
+
|
|
2802
|
+
begin
|
|
2803
|
+
#Get pbx classes of service
|
|
2804
|
+
result = api_instance.get_pbx_classes_of_service
|
|
2805
|
+
p result
|
|
2806
|
+
rescue UltracartClient::ApiError => e
|
|
2807
|
+
puts "Exception when calling ConversationApi->get_pbx_classes_of_service: #{e}"
|
|
2808
|
+
end
|
|
2809
|
+
```
|
|
2810
|
+
|
|
2811
|
+
### Parameters
|
|
2812
|
+
This endpoint does not need any parameter.
|
|
2813
|
+
|
|
2814
|
+
### Return type
|
|
2815
|
+
|
|
2816
|
+
[**ConversationPbxClassOfServicesResponse**](ConversationPbxClassOfServicesResponse.md)
|
|
2817
|
+
|
|
2818
|
+
### Authorization
|
|
2819
|
+
|
|
2820
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2821
|
+
|
|
2822
|
+
### HTTP request headers
|
|
2823
|
+
|
|
2824
|
+
- **Content-Type**: application/json
|
|
2825
|
+
- **Accept**: application/json
|
|
2826
|
+
|
|
2827
|
+
|
|
2828
|
+
|
|
2829
|
+
# **get_pbx_cos_audit_logs**
|
|
2830
|
+
> ConversationPbxCosAuditLogsResponse get_pbx_cos_audit_logs(opts)
|
|
2831
|
+
|
|
2832
|
+
Get pbx class of service audit logs
|
|
2833
|
+
|
|
2834
|
+
Retrieve audit log entries for class of service enforcement
|
|
2835
|
+
|
|
2836
|
+
### Example
|
|
2837
|
+
```ruby
|
|
2838
|
+
# load the gem
|
|
2839
|
+
require 'ultracart_api'
|
|
2840
|
+
|
|
2841
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
2842
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
2843
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
2844
|
+
|
|
2845
|
+
|
|
2846
|
+
opts = {
|
|
2847
|
+
since: 'since_example', # String | ISO timestamp to filter entries since
|
|
2848
|
+
agent_login: 'agent_login_example', # String | Filter by agent login
|
|
2849
|
+
limit: 56 # Integer | Maximum number of entries to return (default 100)
|
|
2850
|
+
}
|
|
2851
|
+
|
|
2852
|
+
begin
|
|
2853
|
+
#Get pbx class of service audit logs
|
|
2854
|
+
result = api_instance.get_pbx_cos_audit_logs(opts)
|
|
2855
|
+
p result
|
|
2856
|
+
rescue UltracartClient::ApiError => e
|
|
2857
|
+
puts "Exception when calling ConversationApi->get_pbx_cos_audit_logs: #{e}"
|
|
2858
|
+
end
|
|
2859
|
+
```
|
|
2860
|
+
|
|
2861
|
+
### Parameters
|
|
2862
|
+
|
|
2863
|
+
Name | Type | Description | Notes
|
|
2864
|
+
------------- | ------------- | ------------- | -------------
|
|
2865
|
+
**since** | **String**| ISO timestamp to filter entries since | [optional]
|
|
2866
|
+
**agent_login** | **String**| Filter by agent login | [optional]
|
|
2867
|
+
**limit** | **Integer**| Maximum number of entries to return (default 100) | [optional]
|
|
2868
|
+
|
|
2869
|
+
### Return type
|
|
2870
|
+
|
|
2871
|
+
[**ConversationPbxCosAuditLogsResponse**](ConversationPbxCosAuditLogsResponse.md)
|
|
2872
|
+
|
|
2873
|
+
### Authorization
|
|
2874
|
+
|
|
2875
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2876
|
+
|
|
2877
|
+
### HTTP request headers
|
|
2878
|
+
|
|
2879
|
+
- **Content-Type**: application/json
|
|
2880
|
+
- **Accept**: application/json
|
|
2881
|
+
|
|
2882
|
+
|
|
2883
|
+
|
|
2678
2884
|
# **get_pbx_hardware_phone**
|
|
2679
2885
|
> ConversationPbxHardwarePhoneResponse get_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
|
|
2680
2886
|
|
|
@@ -3934,6 +4140,56 @@ Name | Type | Description | Notes
|
|
|
3934
4140
|
|
|
3935
4141
|
|
|
3936
4142
|
|
|
4143
|
+
# **insert_pbx_class_of_service**
|
|
4144
|
+
> ConversationPbxClassOfServiceResponse insert_pbx_class_of_service(class_of_service)
|
|
4145
|
+
|
|
4146
|
+
Insert pbx class of service
|
|
4147
|
+
|
|
4148
|
+
Create a new class of service
|
|
4149
|
+
|
|
4150
|
+
### Example
|
|
4151
|
+
```ruby
|
|
4152
|
+
# load the gem
|
|
4153
|
+
require 'ultracart_api'
|
|
4154
|
+
|
|
4155
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
4156
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
4157
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
4158
|
+
|
|
4159
|
+
|
|
4160
|
+
class_of_service = UltracartClient::ConversationPbxClassOfService.new # ConversationPbxClassOfService | Class of service
|
|
4161
|
+
|
|
4162
|
+
|
|
4163
|
+
begin
|
|
4164
|
+
#Insert pbx class of service
|
|
4165
|
+
result = api_instance.insert_pbx_class_of_service(class_of_service)
|
|
4166
|
+
p result
|
|
4167
|
+
rescue UltracartClient::ApiError => e
|
|
4168
|
+
puts "Exception when calling ConversationApi->insert_pbx_class_of_service: #{e}"
|
|
4169
|
+
end
|
|
4170
|
+
```
|
|
4171
|
+
|
|
4172
|
+
### Parameters
|
|
4173
|
+
|
|
4174
|
+
Name | Type | Description | Notes
|
|
4175
|
+
------------- | ------------- | ------------- | -------------
|
|
4176
|
+
**class_of_service** | [**ConversationPbxClassOfService**](ConversationPbxClassOfService.md)| Class of service |
|
|
4177
|
+
|
|
4178
|
+
### Return type
|
|
4179
|
+
|
|
4180
|
+
[**ConversationPbxClassOfServiceResponse**](ConversationPbxClassOfServiceResponse.md)
|
|
4181
|
+
|
|
4182
|
+
### Authorization
|
|
4183
|
+
|
|
4184
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4185
|
+
|
|
4186
|
+
### HTTP request headers
|
|
4187
|
+
|
|
4188
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
4189
|
+
- **Accept**: application/json
|
|
4190
|
+
|
|
4191
|
+
|
|
4192
|
+
|
|
3937
4193
|
# **insert_pbx_hardware_phone**
|
|
3938
4194
|
> ConversationPbxHardwarePhoneResponse insert_pbx_hardware_phone(pbx_hardware_phone)
|
|
3939
4195
|
|
|
@@ -5435,6 +5691,59 @@ Name | Type | Description | Notes
|
|
|
5435
5691
|
|
|
5436
5692
|
|
|
5437
5693
|
|
|
5694
|
+
# **update_pbx_class_of_service**
|
|
5695
|
+
> ConversationPbxClassOfServiceResponse update_pbx_class_of_service(class_of_service_uuid, class_of_service)
|
|
5696
|
+
|
|
5697
|
+
Update pbx class of service
|
|
5698
|
+
|
|
5699
|
+
Update an existing class of service
|
|
5700
|
+
|
|
5701
|
+
### Example
|
|
5702
|
+
```ruby
|
|
5703
|
+
# load the gem
|
|
5704
|
+
require 'ultracart_api'
|
|
5705
|
+
|
|
5706
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
5707
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
5708
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
5709
|
+
|
|
5710
|
+
|
|
5711
|
+
class_of_service_uuid = 'class_of_service_uuid_example' # String |
|
|
5712
|
+
|
|
5713
|
+
class_of_service = UltracartClient::ConversationPbxClassOfService.new # ConversationPbxClassOfService | Class of service
|
|
5714
|
+
|
|
5715
|
+
|
|
5716
|
+
begin
|
|
5717
|
+
#Update pbx class of service
|
|
5718
|
+
result = api_instance.update_pbx_class_of_service(class_of_service_uuid, class_of_service)
|
|
5719
|
+
p result
|
|
5720
|
+
rescue UltracartClient::ApiError => e
|
|
5721
|
+
puts "Exception when calling ConversationApi->update_pbx_class_of_service: #{e}"
|
|
5722
|
+
end
|
|
5723
|
+
```
|
|
5724
|
+
|
|
5725
|
+
### Parameters
|
|
5726
|
+
|
|
5727
|
+
Name | Type | Description | Notes
|
|
5728
|
+
------------- | ------------- | ------------- | -------------
|
|
5729
|
+
**class_of_service_uuid** | **String**| |
|
|
5730
|
+
**class_of_service** | [**ConversationPbxClassOfService**](ConversationPbxClassOfService.md)| Class of service |
|
|
5731
|
+
|
|
5732
|
+
### Return type
|
|
5733
|
+
|
|
5734
|
+
[**ConversationPbxClassOfServiceResponse**](ConversationPbxClassOfServiceResponse.md)
|
|
5735
|
+
|
|
5736
|
+
### Authorization
|
|
5737
|
+
|
|
5738
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5739
|
+
|
|
5740
|
+
### HTTP request headers
|
|
5741
|
+
|
|
5742
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
5743
|
+
- **Accept**: application/json
|
|
5744
|
+
|
|
5745
|
+
|
|
5746
|
+
|
|
5438
5747
|
# **update_pbx_hardware_phone**
|
|
5439
5748
|
> ConversationPbxHardwarePhoneResponse update_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
|
|
5440
5749
|
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**call_routing_preference** | **String** | The call routing preference | [optional]
|
|
8
8
|
**cellphone** | **String** | Cellphone number of agent in E.164 format | [optional]
|
|
9
9
|
**conversation_pbx_agent_uuid** | **String** | Conversation Pbx Agent unique identifier | [optional]
|
|
10
|
+
**cos_uuid** | **String** | Class of Service UUID. If null, the merchant default CoS applies. | [optional]
|
|
10
11
|
**default_phone_number_uuid** | **String** | The default phone number that this agent should dial out to the PSTN with. | [optional]
|
|
11
12
|
**extension** | **Integer** | Extension | [optional]
|
|
12
13
|
**full_name** | **String** | Full name | [optional]
|
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**channels** | **Integer** | Number of audio channels in the recording (1 for mono, 2 for stereo/dual-channel) | [optional]
|
|
7
7
|
**duration_seconds** | **Integer** | Duration of the recording in seconds | [optional]
|
|
8
8
|
**is_primary** | **BOOLEAN** | Whether this is the primary recording for the call | [optional]
|
|
9
|
+
**recording_s3_key** | **String** | S3 key for the recording audio file | [optional]
|
|
9
10
|
**recording_sid** | **String** | Twilio recording SID | [optional]
|
|
10
11
|
**recording_url** | **String** | URL to access the recording | [optional]
|
|
11
12
|
**status** | **String** | Status of the recording | [optional]
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxClassOfService
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**allowed_countries** | **Array<String>** | E.164 country calling codes (e.g. 1 for US/Canada, 44 for UK). Empty means domestic only. | [optional]
|
|
7
|
+
**block_premium_numbers** | **BOOLEAN** | Block calls to 900, 976, premium-rate, and shortcode destinations | [optional]
|
|
8
|
+
**conversation_pbx_class_of_service_uuid** | **String** | Class of Service unique identifier | [optional]
|
|
9
|
+
**default_flag** | **BOOLEAN** | If true, this CoS applies to all agents without an explicit cos_uuid. Only one per merchant. | [optional]
|
|
10
|
+
**description** | **String** | Description of the class of service | [optional]
|
|
11
|
+
**merchant_id** | **String** | Merchant Id | [optional]
|
|
12
|
+
**name** | **String** | Display name for the class of service | [optional]
|
|
13
|
+
**outbound_enabled** | **BOOLEAN** | Whether agents with this CoS can make outbound calls | [optional]
|
|
14
|
+
**time_range_uuid** | **String** | UUID of a time range. If set, outbound calls only permitted during those time windows. | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxClassOfServiceResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**class_of_service** | [**ConversationPbxClassOfService**](ConversationPbxClassOfService.md) | | [optional]
|
|
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
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxClassOfServicesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**classes_of_services** | [**Array<ConversationPbxClassOfService>**](ConversationPbxClassOfService.md) | Array of class of service records | [optional]
|
|
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
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCosAuditLog
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**action** | **String** | Action taken | [optional]
|
|
7
|
+
**agent_login** | **String** | Login of the agent who attempted the call | [optional]
|
|
8
|
+
**audit_log_uuid** | **String** | Audit log entry unique identifier | [optional]
|
|
9
|
+
**class_of_service_name** | **String** | Name of the class of service (denormalized for display) | [optional]
|
|
10
|
+
**class_of_service_uuid** | **String** | UUID of the class of service that was evaluated | [optional]
|
|
11
|
+
**destination** | **String** | Phone number the agent tried to dial | [optional]
|
|
12
|
+
**merchant_id** | **String** | Merchant Id | [optional]
|
|
13
|
+
**rule_triggered** | **String** | Rule that triggered the action | [optional]
|
|
14
|
+
**supervisor_login** | **String** | Login of supervisor who approved/denied (null for timeouts and direct blocks) | [optional]
|
|
15
|
+
**timestamp** | **String** | ISO 8601 timestamp of the event | [optional]
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxCosAuditLogsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**audit_logs** | [**Array<ConversationPbxCosAuditLog>**](ConversationPbxCosAuditLog.md) | Array of audit log entries | [optional]
|
|
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
|
+
|
|
12
|
+
|
data/docs/Twilio.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**account_sid** | **String** | | [optional]
|
|
7
|
+
**ai_twiml_app_sid** | **String** | | [optional]
|
|
7
8
|
**api_key_id** | **String** | | [optional]
|
|
8
9
|
**api_key_name** | **String** | | [optional]
|
|
9
10
|
**auth_token** | **String** | | [optional]
|