ultracart_api 4.1.56 → 4.1.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1c64b1e5c16c28ad0d0d04b7c0a396fd3a1816ddc4c218077125c200ecf10a88
4
- data.tar.gz: 745fcd1cd5b2c5985b9d1012c420960931cb507c920c5acd1502baf477459a19
3
+ metadata.gz: 9498240fb0695280ac3c7c08be852d2e493aacf97bdc1acbfd2582de6185e105
4
+ data.tar.gz: a60ae09cf9b122ad973a2b0101be7846ebbc06ffd107101aae321331d73c36da
5
5
  SHA512:
6
- metadata.gz: f338da784bc80f385ced4883f9ec1426205381cc72ae3da58f758bf3e5291e68bc3e749b662ebd570412806931d57c9395b31c1ae5014add6e47156d39bd00d3
7
- data.tar.gz: 4a6a0ca7e9a7437b5910d35dadff63b6b4123fbce7e54bf05a4c442e8b5e2ef4b6c1a21a76f75acd686ef69c94f63136c50cf6b8ed5d4606d51042458942fd1f
6
+ metadata.gz: 6e88ae0c21d05a118352e9ef8d799e2e2ca2317e540e885d00414d1446a378be0addf323387010498b01fcd35d5d9adcb4f216ea3d848221165d2fde22763170
7
+ data.tar.gz: 87a375ac90b8ebeb5ba344659f96cea76f8676a2b64ab989b42ccaefb20733bdd7254042ab680402da89b16f3532728adedeb605ec2d1bca49a1412db7ee0fd0
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.56
10
+ - Package version: 4.1.57
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.56'
19
+ gem 'ultracart_api', '4.1.57'
20
20
  ```
21
21
 
22
22
  install:
@@ -137,6 +137,7 @@ Class | Method | HTTP request | Description
137
137
  *UltracartClient::ConversationApi* | [**delete_pbx_address**](docs/ConversationApi.md#delete_pbx_address) | **DELETE** /conversation/pbx/address/{conversationPbxAddressUuid} | Delete pbx address
138
138
  *UltracartClient::ConversationApi* | [**delete_pbx_agent_voicemail**](docs/ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
139
139
  *UltracartClient::ConversationApi* | [**delete_pbx_audio**](docs/ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
140
+ *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
140
141
  *UltracartClient::ConversationApi* | [**delete_pbx_hardware_phone**](docs/ConversationApi.md#delete_pbx_hardware_phone) | **DELETE** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Delete pbx hardware phone
141
142
  *UltracartClient::ConversationApi* | [**delete_pbx_menu**](docs/ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
142
143
  *UltracartClient::ConversationApi* | [**delete_pbx_phone_number**](docs/ConversationApi.md#delete_pbx_phone_number) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
@@ -181,6 +182,9 @@ Class | Method | HTTP request | Description
181
182
  *UltracartClient::ConversationApi* | [**get_pbx_audio_usage**](docs/ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
182
183
  *UltracartClient::ConversationApi* | [**get_pbx_audios**](docs/ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
183
184
  *UltracartClient::ConversationApi* | [**get_pbx_call**](docs/ConversationApi.md#get_pbx_call) | **GET** /conversation/pbx/call/{callUuid} | Get pbx call record
185
+ *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
186
+ *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
187
+ *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
184
188
  *UltracartClient::ConversationApi* | [**get_pbx_hardware_phone**](docs/ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone
185
189
  *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
186
190
  *UltracartClient::ConversationApi* | [**get_pbx_hardware_phones**](docs/ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
@@ -207,6 +211,7 @@ Class | Method | HTTP request | Description
207
211
  *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
208
212
  *UltracartClient::ConversationApi* | [**insert_pbx_address**](docs/ConversationApi.md#insert_pbx_address) | **POST** /conversation/pbx/address | Insert pbx address
209
213
  *UltracartClient::ConversationApi* | [**insert_pbx_audio**](docs/ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
214
+ *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
210
215
  *UltracartClient::ConversationApi* | [**insert_pbx_hardware_phone**](docs/ConversationApi.md#insert_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone | Insert pbx hardware phone
211
216
  *UltracartClient::ConversationApi* | [**insert_pbx_menu**](docs/ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
212
217
  *UltracartClient::ConversationApi* | [**insert_pbx_queue**](docs/ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
@@ -236,6 +241,7 @@ Class | Method | HTTP request | Description
236
241
  *UltracartClient::ConversationApi* | [**update_pbx_address**](docs/ConversationApi.md#update_pbx_address) | **PUT** /conversation/pbx/address/{conversationPbxAddressUuid} | Update pbx address
237
242
  *UltracartClient::ConversationApi* | [**update_pbx_agent**](docs/ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
238
243
  *UltracartClient::ConversationApi* | [**update_pbx_audio**](docs/ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
244
+ *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
239
245
  *UltracartClient::ConversationApi* | [**update_pbx_hardware_phone**](docs/ConversationApi.md#update_pbx_hardware_phone) | **PUT** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Update pbx hardware phone
240
246
  *UltracartClient::ConversationApi* | [**update_pbx_menu**](docs/ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
241
247
  *UltracartClient::ConversationApi* | [**update_pbx_phone_number**](docs/ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
@@ -857,6 +863,11 @@ Class | Method | HTTP request | Description
857
863
  - [UltracartClient::ConversationPbxCallTranscript](docs/ConversationPbxCallTranscript.md)
858
864
  - [UltracartClient::ConversationPbxCallTranscriptSegment](docs/ConversationPbxCallTranscriptSegment.md)
859
865
  - [UltracartClient::ConversationPbxCallTransfer](docs/ConversationPbxCallTransfer.md)
866
+ - [UltracartClient::ConversationPbxClassOfService](docs/ConversationPbxClassOfService.md)
867
+ - [UltracartClient::ConversationPbxClassOfServiceResponse](docs/ConversationPbxClassOfServiceResponse.md)
868
+ - [UltracartClient::ConversationPbxClassOfServicesResponse](docs/ConversationPbxClassOfServicesResponse.md)
869
+ - [UltracartClient::ConversationPbxCosAuditLog](docs/ConversationPbxCosAuditLog.md)
870
+ - [UltracartClient::ConversationPbxCosAuditLogsResponse](docs/ConversationPbxCosAuditLogsResponse.md)
860
871
  - [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
861
872
  - [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
862
873
  - [UltracartClient::ConversationPbxHardwarePhone](docs/ConversationPbxHardwarePhone.md)
@@ -1656,6 +1667,7 @@ Not every change is committed to every SDK.
1656
1667
 
1657
1668
  | Version | Date | Comments |
1658
1669
  | --: | :-: | --- |
1670
+ | 4.1.57 | 02/03/2026 | conversations - pbx class of service objects and endpoints |
1659
1671
  | 4.1.56 | 02/02/2026 | conversations - add default phone number to the agent auth |
1660
1672
  | 4.1.55 | 02/02/2026 | conversations - add enumerated values for say voice on queue and agent |
1661
1673
  | 4.1.54 | 02/02/2026 | build error fix |
@@ -8,6 +8,7 @@
8
8
  | **chat_user** | **Boolean** | | [optional] |
9
9
  | **conversation_participant_arn** | **String** | | [optional] |
10
10
  | **conversation_participant_name** | **String** | | [optional] |
11
+ | **default_phone_number** | **String** | The default phone number this agent should use when making an outbound call. | [optional] |
11
12
  | **group_ids** | **Array<Integer>** | UltraCart Groups this user belongs to | [optional] |
12
13
  | **jwt** | **String** | | [optional] |
13
14
  | **merchant_id** | **String** | | [optional] |
@@ -33,6 +34,7 @@ instance = UltracartClient::ConversationAgentAuth.new(
33
34
  chat_user: null,
34
35
  conversation_participant_arn: null,
35
36
  conversation_participant_name: null,
37
+ default_phone_number: null,
36
38
  group_ids: null,
37
39
  jwt: null,
38
40
  merchant_id: null,
@@ -12,6 +12,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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 |
@@ -553,6 +559,59 @@ end
553
559
  - **Accept**: application/json
554
560
 
555
561
 
562
+ ## delete_pbx_class_of_service
563
+
564
+ > <BaseResponse> delete_pbx_class_of_service(class_of_service_uuid)
565
+
566
+ Delete pbx class of service
567
+
568
+ Delete a class of service
569
+
570
+
571
+ ### Examples
572
+
573
+
574
+ (No example for this operation).
575
+
576
+
577
+ #### Using the delete_pbx_class_of_service_with_http_info variant
578
+
579
+ This returns an Array which contains the response data, status code and headers.
580
+
581
+ > <Array(<BaseResponse>, Integer, Hash)> delete_pbx_class_of_service_with_http_info(class_of_service_uuid)
582
+
583
+ ```ruby
584
+ begin
585
+ # Delete pbx class of service
586
+ data, status_code, headers = api_instance.delete_pbx_class_of_service_with_http_info(class_of_service_uuid)
587
+ p status_code # => 2xx
588
+ p headers # => { ... }
589
+ p data # => <BaseResponse>
590
+ rescue UltracartClient::ApiError => e
591
+ puts "Error when calling ConversationApi->delete_pbx_class_of_service_with_http_info: #{e}"
592
+ end
593
+ ```
594
+
595
+ ### Parameters
596
+
597
+ | Name | Type | Description | Notes |
598
+ | ---- | ---- | ----------- | ----- |
599
+ | **class_of_service_uuid** | **String** | | |
600
+
601
+ ### Return type
602
+
603
+ [**BaseResponse**](BaseResponse.md)
604
+
605
+ ### Authorization
606
+
607
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
608
+
609
+ ### HTTP request headers
610
+
611
+ - **Content-Type**: Not defined
612
+ - **Accept**: application/json
613
+
614
+
556
615
  ## delete_pbx_hardware_phone
557
616
 
558
617
  > <ConversationPbxHardwarePhoneResponse> delete_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
@@ -2899,6 +2958,165 @@ end
2899
2958
  - **Accept**: application/json
2900
2959
 
2901
2960
 
2961
+ ## get_pbx_class_of_service
2962
+
2963
+ > <ConversationPbxClassOfServiceResponse> get_pbx_class_of_service(class_of_service_uuid)
2964
+
2965
+ Get pbx class of service
2966
+
2967
+ Retrieve a single class of service
2968
+
2969
+
2970
+ ### Examples
2971
+
2972
+
2973
+ (No example for this operation).
2974
+
2975
+
2976
+ #### Using the get_pbx_class_of_service_with_http_info variant
2977
+
2978
+ This returns an Array which contains the response data, status code and headers.
2979
+
2980
+ > <Array(<ConversationPbxClassOfServiceResponse>, Integer, Hash)> get_pbx_class_of_service_with_http_info(class_of_service_uuid)
2981
+
2982
+ ```ruby
2983
+ begin
2984
+ # Get pbx class of service
2985
+ data, status_code, headers = api_instance.get_pbx_class_of_service_with_http_info(class_of_service_uuid)
2986
+ p status_code # => 2xx
2987
+ p headers # => { ... }
2988
+ p data # => <ConversationPbxClassOfServiceResponse>
2989
+ rescue UltracartClient::ApiError => e
2990
+ puts "Error when calling ConversationApi->get_pbx_class_of_service_with_http_info: #{e}"
2991
+ end
2992
+ ```
2993
+
2994
+ ### Parameters
2995
+
2996
+ | Name | Type | Description | Notes |
2997
+ | ---- | ---- | ----------- | ----- |
2998
+ | **class_of_service_uuid** | **String** | | |
2999
+
3000
+ ### Return type
3001
+
3002
+ [**ConversationPbxClassOfServiceResponse**](ConversationPbxClassOfServiceResponse.md)
3003
+
3004
+ ### Authorization
3005
+
3006
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3007
+
3008
+ ### HTTP request headers
3009
+
3010
+ - **Content-Type**: Not defined
3011
+ - **Accept**: application/json
3012
+
3013
+
3014
+ ## get_pbx_classes_of_service
3015
+
3016
+ > <ConversationPbxClassOfServicesResponse> get_pbx_classes_of_service
3017
+
3018
+ Get pbx classes of service
3019
+
3020
+ Retrieve all classes of service for the merchant
3021
+
3022
+
3023
+ ### Examples
3024
+
3025
+
3026
+ (No example for this operation).
3027
+
3028
+
3029
+ #### Using the get_pbx_classes_of_service_with_http_info variant
3030
+
3031
+ This returns an Array which contains the response data, status code and headers.
3032
+
3033
+ > <Array(<ConversationPbxClassOfServicesResponse>, Integer, Hash)> get_pbx_classes_of_service_with_http_info
3034
+
3035
+ ```ruby
3036
+ begin
3037
+ # Get pbx classes of service
3038
+ data, status_code, headers = api_instance.get_pbx_classes_of_service_with_http_info
3039
+ p status_code # => 2xx
3040
+ p headers # => { ... }
3041
+ p data # => <ConversationPbxClassOfServicesResponse>
3042
+ rescue UltracartClient::ApiError => e
3043
+ puts "Error when calling ConversationApi->get_pbx_classes_of_service_with_http_info: #{e}"
3044
+ end
3045
+ ```
3046
+
3047
+ ### Parameters
3048
+
3049
+ This endpoint does not need any parameter.
3050
+
3051
+ ### Return type
3052
+
3053
+ [**ConversationPbxClassOfServicesResponse**](ConversationPbxClassOfServicesResponse.md)
3054
+
3055
+ ### Authorization
3056
+
3057
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3058
+
3059
+ ### HTTP request headers
3060
+
3061
+ - **Content-Type**: Not defined
3062
+ - **Accept**: application/json
3063
+
3064
+
3065
+ ## get_pbx_cos_audit_logs
3066
+
3067
+ > <ConversationPbxCosAuditLogsResponse> get_pbx_cos_audit_logs(opts)
3068
+
3069
+ Get pbx class of service audit logs
3070
+
3071
+ Retrieve audit log entries for class of service enforcement
3072
+
3073
+
3074
+ ### Examples
3075
+
3076
+
3077
+ (No example for this operation).
3078
+
3079
+
3080
+ #### Using the get_pbx_cos_audit_logs_with_http_info variant
3081
+
3082
+ This returns an Array which contains the response data, status code and headers.
3083
+
3084
+ > <Array(<ConversationPbxCosAuditLogsResponse>, Integer, Hash)> get_pbx_cos_audit_logs_with_http_info(opts)
3085
+
3086
+ ```ruby
3087
+ begin
3088
+ # Get pbx class of service audit logs
3089
+ data, status_code, headers = api_instance.get_pbx_cos_audit_logs_with_http_info(opts)
3090
+ p status_code # => 2xx
3091
+ p headers # => { ... }
3092
+ p data # => <ConversationPbxCosAuditLogsResponse>
3093
+ rescue UltracartClient::ApiError => e
3094
+ puts "Error when calling ConversationApi->get_pbx_cos_audit_logs_with_http_info: #{e}"
3095
+ end
3096
+ ```
3097
+
3098
+ ### Parameters
3099
+
3100
+ | Name | Type | Description | Notes |
3101
+ | ---- | ---- | ----------- | ----- |
3102
+ | **since** | **String** | ISO timestamp to filter entries since | [optional] |
3103
+ | **agent_login** | **String** | Filter by agent login | [optional] |
3104
+ | **limit** | **Integer** | Maximum number of entries to return (default 100) | [optional] |
3105
+
3106
+ ### Return type
3107
+
3108
+ [**ConversationPbxCosAuditLogsResponse**](ConversationPbxCosAuditLogsResponse.md)
3109
+
3110
+ ### Authorization
3111
+
3112
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3113
+
3114
+ ### HTTP request headers
3115
+
3116
+ - **Content-Type**: Not defined
3117
+ - **Accept**: application/json
3118
+
3119
+
2902
3120
  ## get_pbx_hardware_phone
2903
3121
 
2904
3122
  > <ConversationPbxHardwarePhoneResponse> get_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
@@ -4278,6 +4496,59 @@ end
4278
4496
  - **Accept**: application/json
4279
4497
 
4280
4498
 
4499
+ ## insert_pbx_class_of_service
4500
+
4501
+ > <ConversationPbxClassOfServiceResponse> insert_pbx_class_of_service(class_of_service)
4502
+
4503
+ Insert pbx class of service
4504
+
4505
+ Create a new class of service
4506
+
4507
+
4508
+ ### Examples
4509
+
4510
+
4511
+ (No example for this operation).
4512
+
4513
+
4514
+ #### Using the insert_pbx_class_of_service_with_http_info variant
4515
+
4516
+ This returns an Array which contains the response data, status code and headers.
4517
+
4518
+ > <Array(<ConversationPbxClassOfServiceResponse>, Integer, Hash)> insert_pbx_class_of_service_with_http_info(class_of_service)
4519
+
4520
+ ```ruby
4521
+ begin
4522
+ # Insert pbx class of service
4523
+ data, status_code, headers = api_instance.insert_pbx_class_of_service_with_http_info(class_of_service)
4524
+ p status_code # => 2xx
4525
+ p headers # => { ... }
4526
+ p data # => <ConversationPbxClassOfServiceResponse>
4527
+ rescue UltracartClient::ApiError => e
4528
+ puts "Error when calling ConversationApi->insert_pbx_class_of_service_with_http_info: #{e}"
4529
+ end
4530
+ ```
4531
+
4532
+ ### Parameters
4533
+
4534
+ | Name | Type | Description | Notes |
4535
+ | ---- | ---- | ----------- | ----- |
4536
+ | **class_of_service** | [**ConversationPbxClassOfService**](ConversationPbxClassOfService.md) | Class of service | |
4537
+
4538
+ ### Return type
4539
+
4540
+ [**ConversationPbxClassOfServiceResponse**](ConversationPbxClassOfServiceResponse.md)
4541
+
4542
+ ### Authorization
4543
+
4544
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4545
+
4546
+ ### HTTP request headers
4547
+
4548
+ - **Content-Type**: application/json; charset=UTF-8
4549
+ - **Accept**: application/json
4550
+
4551
+
4281
4552
  ## insert_pbx_hardware_phone
4282
4553
 
4283
4554
  > <ConversationPbxHardwarePhoneResponse> insert_pbx_hardware_phone(pbx_hardware_phone)
@@ -5857,6 +6128,60 @@ end
5857
6128
  - **Accept**: application/json
5858
6129
 
5859
6130
 
6131
+ ## update_pbx_class_of_service
6132
+
6133
+ > <ConversationPbxClassOfServiceResponse> update_pbx_class_of_service(class_of_service_uuid, class_of_service)
6134
+
6135
+ Update pbx class of service
6136
+
6137
+ Update an existing class of service
6138
+
6139
+
6140
+ ### Examples
6141
+
6142
+
6143
+ (No example for this operation).
6144
+
6145
+
6146
+ #### Using the update_pbx_class_of_service_with_http_info variant
6147
+
6148
+ This returns an Array which contains the response data, status code and headers.
6149
+
6150
+ > <Array(<ConversationPbxClassOfServiceResponse>, Integer, Hash)> update_pbx_class_of_service_with_http_info(class_of_service_uuid, class_of_service)
6151
+
6152
+ ```ruby
6153
+ begin
6154
+ # Update pbx class of service
6155
+ data, status_code, headers = api_instance.update_pbx_class_of_service_with_http_info(class_of_service_uuid, class_of_service)
6156
+ p status_code # => 2xx
6157
+ p headers # => { ... }
6158
+ p data # => <ConversationPbxClassOfServiceResponse>
6159
+ rescue UltracartClient::ApiError => e
6160
+ puts "Error when calling ConversationApi->update_pbx_class_of_service_with_http_info: #{e}"
6161
+ end
6162
+ ```
6163
+
6164
+ ### Parameters
6165
+
6166
+ | Name | Type | Description | Notes |
6167
+ | ---- | ---- | ----------- | ----- |
6168
+ | **class_of_service_uuid** | **String** | | |
6169
+ | **class_of_service** | [**ConversationPbxClassOfService**](ConversationPbxClassOfService.md) | Class of service | |
6170
+
6171
+ ### Return type
6172
+
6173
+ [**ConversationPbxClassOfServiceResponse**](ConversationPbxClassOfServiceResponse.md)
6174
+
6175
+ ### Authorization
6176
+
6177
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6178
+
6179
+ ### HTTP request headers
6180
+
6181
+ - **Content-Type**: application/json; charset=UTF-8
6182
+ - **Accept**: application/json
6183
+
6184
+
5860
6185
  ## update_pbx_hardware_phone
5861
6186
 
5862
6187
  > <ConversationPbxHardwarePhoneResponse> update_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)
@@ -8,6 +8,7 @@
8
8
  | **call_routing_preference** | **String** | The call routing preference | [optional] |
9
9
  | **cellphone** | **String** | Cellphone number of agent in E.164 format | [optional] |
10
10
  | **conversation_pbx_agent_uuid** | **String** | Conversation Pbx Agent unique identifier | [optional] |
11
+ | **cos_uuid** | **String** | Class of Service UUID. If null, the merchant default CoS applies. | [optional] |
11
12
  | **default_phone_number_uuid** | **String** | The default phone number that this agent should dial out to the PSTN with. | [optional] |
12
13
  | **extension** | **Integer** | Extension | [optional] |
13
14
  | **full_name** | **String** | Full name | [optional] |
@@ -35,6 +36,7 @@ instance = UltracartClient::ConversationPbxAgent.new(
35
36
  call_routing_preference: null,
36
37
  cellphone: null,
37
38
  conversation_pbx_agent_uuid: null,
39
+ cos_uuid: null,
38
40
  default_phone_number_uuid: null,
39
41
  extension: null,
40
42
  full_name: null,
@@ -7,6 +7,7 @@
7
7
  | **channels** | **Integer** | Number of audio channels in the recording (1 for mono, 2 for stereo/dual-channel) | [optional] |
8
8
  | **duration_seconds** | **Integer** | Duration of the recording in seconds | [optional] |
9
9
  | **is_primary** | **Boolean** | Whether this is the primary recording for the call | [optional] |
10
+ | **recording_s3_key** | **String** | S3 key for the recording audio file | [optional] |
10
11
  | **recording_sid** | **String** | Twilio recording SID | [optional] |
11
12
  | **recording_url** | **String** | URL to access the recording | [optional] |
12
13
  | **status** | **String** | Status of the recording | [optional] |
@@ -21,6 +22,7 @@ instance = UltracartClient::ConversationPbxCallRecording.new(
21
22
  channels: null,
22
23
  duration_seconds: null,
23
24
  is_primary: null,
25
+ recording_s3_key: null,
24
26
  recording_sid: null,
25
27
  recording_url: null,
26
28
  status: null,
@@ -0,0 +1,34 @@
1
+ # UltracartClient::ConversationPbxClassOfService
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allowed_countries** | **Array&lt;String&gt;** | E.164 country calling codes (e.g. 1 for US/Canada, 44 for UK). Empty means domestic only. | [optional] |
8
+ | **block_premium_numbers** | **Boolean** | Block calls to 900, 976, premium-rate, and shortcode destinations | [optional] |
9
+ | **conversation_pbx_class_of_service_uuid** | **String** | Class of Service unique identifier | [optional] |
10
+ | **default_flag** | **Boolean** | If true, this CoS applies to all agents without an explicit cos_uuid. Only one per merchant. | [optional] |
11
+ | **description** | **String** | Description of the class of service | [optional] |
12
+ | **merchant_id** | **String** | Merchant Id | [optional] |
13
+ | **name** | **String** | Display name for the class of service | [optional] |
14
+ | **outbound_enabled** | **Boolean** | Whether agents with this CoS can make outbound calls | [optional] |
15
+ | **time_range_uuid** | **String** | UUID of a time range. If set, outbound calls only permitted during those time windows. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'ultracart_api'
21
+
22
+ instance = UltracartClient::ConversationPbxClassOfService.new(
23
+ allowed_countries: null,
24
+ block_premium_numbers: null,
25
+ conversation_pbx_class_of_service_uuid: null,
26
+ default_flag: null,
27
+ description: null,
28
+ merchant_id: null,
29
+ name: null,
30
+ outbound_enabled: null,
31
+ time_range_uuid: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ConversationPbxClassOfServiceResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **class_of_service** | [**ConversationPbxClassOfService**](ConversationPbxClassOfService.md) | | [optional] |
8
+ | **error** | [**Error**](Error.md) | | [optional] |
9
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ConversationPbxClassOfServiceResponse.new(
19
+ class_of_service: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ConversationPbxClassOfServicesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **classes_of_services** | [**Array&lt;ConversationPbxClassOfService&gt;**](ConversationPbxClassOfService.md) | Array of class of service records | [optional] |
8
+ | **error** | [**Error**](Error.md) | | [optional] |
9
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ConversationPbxClassOfServicesResponse.new(
19
+ classes_of_services: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,36 @@
1
+ # UltracartClient::ConversationPbxCosAuditLog
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **action** | **String** | Action taken | [optional] |
8
+ | **agent_login** | **String** | Login of the agent who attempted the call | [optional] |
9
+ | **audit_log_uuid** | **String** | Audit log entry unique identifier | [optional] |
10
+ | **class_of_service_name** | **String** | Name of the class of service (denormalized for display) | [optional] |
11
+ | **class_of_service_uuid** | **String** | UUID of the class of service that was evaluated | [optional] |
12
+ | **destination** | **String** | Phone number the agent tried to dial | [optional] |
13
+ | **merchant_id** | **String** | Merchant Id | [optional] |
14
+ | **rule_triggered** | **String** | Rule that triggered the action | [optional] |
15
+ | **supervisor_login** | **String** | Login of supervisor who approved/denied (null for timeouts and direct blocks) | [optional] |
16
+ | **timestamp** | **String** | ISO 8601 timestamp of the event | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'ultracart_api'
22
+
23
+ instance = UltracartClient::ConversationPbxCosAuditLog.new(
24
+ action: null,
25
+ agent_login: null,
26
+ audit_log_uuid: null,
27
+ class_of_service_name: null,
28
+ class_of_service_uuid: null,
29
+ destination: null,
30
+ merchant_id: null,
31
+ rule_triggered: null,
32
+ supervisor_login: null,
33
+ timestamp: null
34
+ )
35
+ ```
36
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ConversationPbxCosAuditLogsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **audit_logs** | [**Array&lt;ConversationPbxCosAuditLog&gt;**](ConversationPbxCosAuditLog.md) | Array of audit log entries | [optional] |
8
+ | **error** | [**Error**](Error.md) | | [optional] |
9
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ConversationPbxCosAuditLogsResponse.new(
19
+ audit_logs: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+