ultracart_api 4.1.56 → 4.1.58
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 -8
- data/docs/ConversationAgentAuth.md +2 -0
- data/docs/ConversationApi.md +326 -0
- data/docs/ConversationPbxAgent.md +2 -0
- data/docs/ConversationPbxCallRecording.md +2 -0
- data/docs/ConversationPbxClassOfService.md +34 -0
- data/docs/{ItemShippingDistributionCenterResponse.md → ConversationPbxClassOfServiceResponse.md} +4 -4
- data/docs/ConversationPbxClassOfServicesResponse.md +26 -0
- data/docs/ConversationPbxCosAuditLog.md +36 -0
- data/docs/ConversationPbxCosAuditLogsResponse.md +26 -0
- data/docs/EmailCommseqPostcard.md +1 -1
- data/docs/ItemApi.md +0 -167
- data/docs/OrderApi.md +56 -0
- data/docs/OrderUpsellCartRequest.md +22 -0
- data/docs/Twilio.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +400 -0
- data/lib/ultracart_api/api/item_api.rb +0 -226
- data/lib/ultracart_api/api/order_api.rb +78 -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 +347 -0
- data/lib/ultracart_api/models/{item_inventory_update.rb → conversation_pbx_class_of_service_response.rb} +41 -25
- data/lib/ultracart_api/models/{item_shipping_distribution_center_response.rb → conversation_pbx_class_of_services_response.rb} +16 -13
- data/lib/ultracart_api/models/conversation_pbx_cos_audit_log.rb +371 -0
- data/lib/ultracart_api/models/conversation_pbx_cos_audit_logs_response.rb +259 -0
- data/lib/ultracart_api/models/conversation_pbx_queue.rb +14 -10
- data/lib/ultracart_api/models/email_commseq_postcard.rb +1 -1
- data/lib/ultracart_api/models/{item_inventory_update_request.rb → order_upsell_cart_request.rb} +31 -12
- data/lib/ultracart_api/models/twilio.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +6 -3
- metadata +14 -8
- data/docs/ItemInventoryUpdate.md +0 -22
- data/docs/ItemInventoryUpdateRequest.md +0 -18
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7d0bf9840e526c1fd1a79d5195fb6d64ce24aa4061ce4fb55a23c3bb19a5d719
|
|
4
|
+
data.tar.gz: 73f41a2e74f316f355d5129625b0fbae7c3fa3a468773a27935d92f89b1a20cd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 04c6b026aaf1afe4880e28bffe349d0c286d7773e5cf582089ed669dbb900ac3c75cf841a7a4976703cb1b741dd7bcff58b7d40e3cad3aa07c661235ca04ccb1
|
|
7
|
+
data.tar.gz: 88da9adbc8e750e6ae220a9e14fd0eeac0e6f2c877922f750842d6727b2a829a5b3349a3bc1bb6628d5429850c4b3956d277ea4a9a453c020e45cc14dd002e14
|
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.58
|
|
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.58'
|
|
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
|
|
@@ -347,7 +353,6 @@ Class | Method | HTTP request | Description
|
|
|
347
353
|
*UltracartClient::ItemApi* | [**get_inventory_snapshot**](docs/ItemApi.md#get_inventory_snapshot) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
348
354
|
*UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
|
|
349
355
|
*UltracartClient::ItemApi* | [**get_item_by_merchant_item_id**](docs/ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
|
|
350
|
-
*UltracartClient::ItemApi* | [**get_item_shipping_distribution_center_by_code**](docs/ItemApi.md#get_item_shipping_distribution_center_by_code) | **GET** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Retrieve an item shipping distribution center
|
|
351
356
|
*UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
|
352
357
|
*UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
|
|
353
358
|
*UltracartClient::ItemApi* | [**get_review**](docs/ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | Get a review
|
|
@@ -359,8 +364,6 @@ Class | Method | HTTP request | Description
|
|
|
359
364
|
*UltracartClient::ItemApi* | [**insert_update_item_content_attribute**](docs/ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
|
|
360
365
|
*UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
|
|
361
366
|
*UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
|
362
|
-
*UltracartClient::ItemApi* | [**update_item_inventories**](docs/ItemApi.md#update_item_inventories) | **PUT** /item/items/update_item_inventories | Update item inventories for a distribution center
|
|
363
|
-
*UltracartClient::ItemApi* | [**update_item_shipping_distribution_center_by_code**](docs/ItemApi.md#update_item_shipping_distribution_center_by_code) | **PUT** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Update an item shipping distribution center
|
|
364
367
|
*UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
|
365
368
|
*UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
|
|
366
369
|
*UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
|
|
@@ -382,6 +385,7 @@ Class | Method | HTTP request | Description
|
|
|
382
385
|
*UltracartClient::OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
|
|
383
386
|
*UltracartClient::OrderApi* | [**get_order_by_token**](docs/OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
|
|
384
387
|
*UltracartClient::OrderApi* | [**get_order_edi_documents**](docs/OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order.
|
|
388
|
+
*UltracartClient::OrderApi* | [**get_order_upsell_cart**](docs/OrderApi.md#get_order_upsell_cart) | **PUT** /order/orders/{order_id}/upsell_with_cart | Get Order Upsell Cart
|
|
385
389
|
*UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
|
|
386
390
|
*UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
|
|
387
391
|
*UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
|
|
@@ -857,6 +861,11 @@ Class | Method | HTTP request | Description
|
|
|
857
861
|
- [UltracartClient::ConversationPbxCallTranscript](docs/ConversationPbxCallTranscript.md)
|
|
858
862
|
- [UltracartClient::ConversationPbxCallTranscriptSegment](docs/ConversationPbxCallTranscriptSegment.md)
|
|
859
863
|
- [UltracartClient::ConversationPbxCallTransfer](docs/ConversationPbxCallTransfer.md)
|
|
864
|
+
- [UltracartClient::ConversationPbxClassOfService](docs/ConversationPbxClassOfService.md)
|
|
865
|
+
- [UltracartClient::ConversationPbxClassOfServiceResponse](docs/ConversationPbxClassOfServiceResponse.md)
|
|
866
|
+
- [UltracartClient::ConversationPbxClassOfServicesResponse](docs/ConversationPbxClassOfServicesResponse.md)
|
|
867
|
+
- [UltracartClient::ConversationPbxCosAuditLog](docs/ConversationPbxCosAuditLog.md)
|
|
868
|
+
- [UltracartClient::ConversationPbxCosAuditLogsResponse](docs/ConversationPbxCosAuditLogsResponse.md)
|
|
860
869
|
- [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
|
|
861
870
|
- [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
|
|
862
871
|
- [UltracartClient::ConversationPbxHardwarePhone](docs/ConversationPbxHardwarePhone.md)
|
|
@@ -1260,8 +1269,6 @@ Class | Method | HTTP request | Description
|
|
|
1260
1269
|
- [UltracartClient::ItemInventorySnapshot](docs/ItemInventorySnapshot.md)
|
|
1261
1270
|
- [UltracartClient::ItemInventorySnapshotDistributionCenter](docs/ItemInventorySnapshotDistributionCenter.md)
|
|
1262
1271
|
- [UltracartClient::ItemInventorySnapshotResponse](docs/ItemInventorySnapshotResponse.md)
|
|
1263
|
-
- [UltracartClient::ItemInventoryUpdate](docs/ItemInventoryUpdate.md)
|
|
1264
|
-
- [UltracartClient::ItemInventoryUpdateRequest](docs/ItemInventoryUpdateRequest.md)
|
|
1265
1272
|
- [UltracartClient::ItemKitComponent](docs/ItemKitComponent.md)
|
|
1266
1273
|
- [UltracartClient::ItemKitDefinition](docs/ItemKitDefinition.md)
|
|
1267
1274
|
- [UltracartClient::ItemOption](docs/ItemOption.md)
|
|
@@ -1293,7 +1300,6 @@ Class | Method | HTTP request | Description
|
|
|
1293
1300
|
- [UltracartClient::ItemShippingDestinationMarkup](docs/ItemShippingDestinationMarkup.md)
|
|
1294
1301
|
- [UltracartClient::ItemShippingDestinationRestriction](docs/ItemShippingDestinationRestriction.md)
|
|
1295
1302
|
- [UltracartClient::ItemShippingDistributionCenter](docs/ItemShippingDistributionCenter.md)
|
|
1296
|
-
- [UltracartClient::ItemShippingDistributionCenterResponse](docs/ItemShippingDistributionCenterResponse.md)
|
|
1297
1303
|
- [UltracartClient::ItemShippingMethod](docs/ItemShippingMethod.md)
|
|
1298
1304
|
- [UltracartClient::ItemShippingPackageRequirement](docs/ItemShippingPackageRequirement.md)
|
|
1299
1305
|
- [UltracartClient::ItemTag](docs/ItemTag.md)
|
|
@@ -1399,6 +1405,7 @@ Class | Method | HTTP request | Description
|
|
|
1399
1405
|
- [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
|
|
1400
1406
|
- [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
|
|
1401
1407
|
- [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
|
|
1408
|
+
- [UltracartClient::OrderUpsellCartRequest](docs/OrderUpsellCartRequest.md)
|
|
1402
1409
|
- [UltracartClient::OrderUtm](docs/OrderUtm.md)
|
|
1403
1410
|
- [UltracartClient::OrderValidationRequest](docs/OrderValidationRequest.md)
|
|
1404
1411
|
- [UltracartClient::OrderValidationResponse](docs/OrderValidationResponse.md)
|
|
@@ -1656,6 +1663,8 @@ Not every change is committed to every SDK.
|
|
|
1656
1663
|
|
|
1657
1664
|
| Version | Date | Comments |
|
|
1658
1665
|
| --: | :-: | --- |
|
|
1666
|
+
| 4.1.58 | 02/10/2026 | conversations - new method to look up an item with sparse variations. |
|
|
1667
|
+
| 4.1.57 | 02/03/2026 | conversations - pbx class of service objects and endpoints |
|
|
1659
1668
|
| 4.1.56 | 02/02/2026 | conversations - add default phone number to the agent auth |
|
|
1660
1669
|
| 4.1.55 | 02/02/2026 | conversations - add enumerated values for say voice on queue and agent |
|
|
1661
1670
|
| 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,
|
data/docs/ConversationApi.md
CHANGED
|
@@ -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,166 @@ 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
|
+
| **action** | **String** | Action | [optional] |
|
|
3105
|
+
| **limit** | **Integer** | Maximum number of entries to return (default 100) | [optional] |
|
|
3106
|
+
|
|
3107
|
+
### Return type
|
|
3108
|
+
|
|
3109
|
+
[**ConversationPbxCosAuditLogsResponse**](ConversationPbxCosAuditLogsResponse.md)
|
|
3110
|
+
|
|
3111
|
+
### Authorization
|
|
3112
|
+
|
|
3113
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3114
|
+
|
|
3115
|
+
### HTTP request headers
|
|
3116
|
+
|
|
3117
|
+
- **Content-Type**: Not defined
|
|
3118
|
+
- **Accept**: application/json
|
|
3119
|
+
|
|
3120
|
+
|
|
2902
3121
|
## get_pbx_hardware_phone
|
|
2903
3122
|
|
|
2904
3123
|
> <ConversationPbxHardwarePhoneResponse> get_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
|
|
@@ -4278,6 +4497,59 @@ end
|
|
|
4278
4497
|
- **Accept**: application/json
|
|
4279
4498
|
|
|
4280
4499
|
|
|
4500
|
+
## insert_pbx_class_of_service
|
|
4501
|
+
|
|
4502
|
+
> <ConversationPbxClassOfServiceResponse> insert_pbx_class_of_service(class_of_service)
|
|
4503
|
+
|
|
4504
|
+
Insert pbx class of service
|
|
4505
|
+
|
|
4506
|
+
Create a new class of service
|
|
4507
|
+
|
|
4508
|
+
|
|
4509
|
+
### Examples
|
|
4510
|
+
|
|
4511
|
+
|
|
4512
|
+
(No example for this operation).
|
|
4513
|
+
|
|
4514
|
+
|
|
4515
|
+
#### Using the insert_pbx_class_of_service_with_http_info variant
|
|
4516
|
+
|
|
4517
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4518
|
+
|
|
4519
|
+
> <Array(<ConversationPbxClassOfServiceResponse>, Integer, Hash)> insert_pbx_class_of_service_with_http_info(class_of_service)
|
|
4520
|
+
|
|
4521
|
+
```ruby
|
|
4522
|
+
begin
|
|
4523
|
+
# Insert pbx class of service
|
|
4524
|
+
data, status_code, headers = api_instance.insert_pbx_class_of_service_with_http_info(class_of_service)
|
|
4525
|
+
p status_code # => 2xx
|
|
4526
|
+
p headers # => { ... }
|
|
4527
|
+
p data # => <ConversationPbxClassOfServiceResponse>
|
|
4528
|
+
rescue UltracartClient::ApiError => e
|
|
4529
|
+
puts "Error when calling ConversationApi->insert_pbx_class_of_service_with_http_info: #{e}"
|
|
4530
|
+
end
|
|
4531
|
+
```
|
|
4532
|
+
|
|
4533
|
+
### Parameters
|
|
4534
|
+
|
|
4535
|
+
| Name | Type | Description | Notes |
|
|
4536
|
+
| ---- | ---- | ----------- | ----- |
|
|
4537
|
+
| **class_of_service** | [**ConversationPbxClassOfService**](ConversationPbxClassOfService.md) | Class of service | |
|
|
4538
|
+
|
|
4539
|
+
### Return type
|
|
4540
|
+
|
|
4541
|
+
[**ConversationPbxClassOfServiceResponse**](ConversationPbxClassOfServiceResponse.md)
|
|
4542
|
+
|
|
4543
|
+
### Authorization
|
|
4544
|
+
|
|
4545
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4546
|
+
|
|
4547
|
+
### HTTP request headers
|
|
4548
|
+
|
|
4549
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
4550
|
+
- **Accept**: application/json
|
|
4551
|
+
|
|
4552
|
+
|
|
4281
4553
|
## insert_pbx_hardware_phone
|
|
4282
4554
|
|
|
4283
4555
|
> <ConversationPbxHardwarePhoneResponse> insert_pbx_hardware_phone(pbx_hardware_phone)
|
|
@@ -5857,6 +6129,60 @@ end
|
|
|
5857
6129
|
- **Accept**: application/json
|
|
5858
6130
|
|
|
5859
6131
|
|
|
6132
|
+
## update_pbx_class_of_service
|
|
6133
|
+
|
|
6134
|
+
> <ConversationPbxClassOfServiceResponse> update_pbx_class_of_service(class_of_service_uuid, class_of_service)
|
|
6135
|
+
|
|
6136
|
+
Update pbx class of service
|
|
6137
|
+
|
|
6138
|
+
Update an existing class of service
|
|
6139
|
+
|
|
6140
|
+
|
|
6141
|
+
### Examples
|
|
6142
|
+
|
|
6143
|
+
|
|
6144
|
+
(No example for this operation).
|
|
6145
|
+
|
|
6146
|
+
|
|
6147
|
+
#### Using the update_pbx_class_of_service_with_http_info variant
|
|
6148
|
+
|
|
6149
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6150
|
+
|
|
6151
|
+
> <Array(<ConversationPbxClassOfServiceResponse>, Integer, Hash)> update_pbx_class_of_service_with_http_info(class_of_service_uuid, class_of_service)
|
|
6152
|
+
|
|
6153
|
+
```ruby
|
|
6154
|
+
begin
|
|
6155
|
+
# Update pbx class of service
|
|
6156
|
+
data, status_code, headers = api_instance.update_pbx_class_of_service_with_http_info(class_of_service_uuid, class_of_service)
|
|
6157
|
+
p status_code # => 2xx
|
|
6158
|
+
p headers # => { ... }
|
|
6159
|
+
p data # => <ConversationPbxClassOfServiceResponse>
|
|
6160
|
+
rescue UltracartClient::ApiError => e
|
|
6161
|
+
puts "Error when calling ConversationApi->update_pbx_class_of_service_with_http_info: #{e}"
|
|
6162
|
+
end
|
|
6163
|
+
```
|
|
6164
|
+
|
|
6165
|
+
### Parameters
|
|
6166
|
+
|
|
6167
|
+
| Name | Type | Description | Notes |
|
|
6168
|
+
| ---- | ---- | ----------- | ----- |
|
|
6169
|
+
| **class_of_service_uuid** | **String** | | |
|
|
6170
|
+
| **class_of_service** | [**ConversationPbxClassOfService**](ConversationPbxClassOfService.md) | Class of service | |
|
|
6171
|
+
|
|
6172
|
+
### Return type
|
|
6173
|
+
|
|
6174
|
+
[**ConversationPbxClassOfServiceResponse**](ConversationPbxClassOfServiceResponse.md)
|
|
6175
|
+
|
|
6176
|
+
### Authorization
|
|
6177
|
+
|
|
6178
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6179
|
+
|
|
6180
|
+
### HTTP request headers
|
|
6181
|
+
|
|
6182
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
6183
|
+
- **Accept**: application/json
|
|
6184
|
+
|
|
6185
|
+
|
|
5860
6186
|
## update_pbx_hardware_phone
|
|
5861
6187
|
|
|
5862
6188
|
> <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<String>** | 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
|
+
|
data/docs/{ItemShippingDistributionCenterResponse.md → ConversationPbxClassOfServiceResponse.md}
RENAMED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# UltracartClient::
|
|
1
|
+
# UltracartClient::ConversationPbxClassOfServiceResponse
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **class_of_service** | [**ConversationPbxClassOfService**](ConversationPbxClassOfService.md) | | [optional] |
|
|
7
8
|
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
|
-
| **item_shipping_distribution_center** | [**ItemShippingDistributionCenter**](ItemShippingDistributionCenter.md) | | [optional] |
|
|
9
9
|
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
10
10
|
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
11
11
|
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
```ruby
|
|
16
16
|
require 'ultracart_api'
|
|
17
17
|
|
|
18
|
-
instance = UltracartClient::
|
|
18
|
+
instance = UltracartClient::ConversationPbxClassOfServiceResponse.new(
|
|
19
|
+
class_of_service: null,
|
|
19
20
|
error: null,
|
|
20
|
-
item_shipping_distribution_center: null,
|
|
21
21
|
metadata: null,
|
|
22
22
|
success: null,
|
|
23
23
|
warning: null
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxClassOfServicesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **classes_of_services** | [**Array<ConversationPbxClassOfService>**](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
|
+
|