ultracart_api 3.11.10 → 3.11.12
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 +14 -4
- data/docs/ConversationApi.md +194 -0
- data/docs/ConversationVirtualAgentBudget.md +11 -0
- data/docs/ConversationVirtualAgentBudgetResponse.md +12 -0
- data/docs/ConversationVirtualAgentCapabilities.md +16 -0
- data/docs/ConversationVirtualAgentCapabilitiesResponse.md +12 -0
- data/lib/ultracart_api/api/conversation_api.rb +208 -0
- data/lib/ultracart_api/models/conversation_virtual_agent_budget.rb +211 -0
- data/lib/ultracart_api/models/conversation_virtual_agent_budget_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +256 -0
- data/lib/ultracart_api/models/conversation_virtual_agent_capabilities_response.rb +221 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8dd6b43df2a59352163bdc4453b58bee736266f702df858212bd39a8ecef74b4
|
4
|
+
data.tar.gz: 8fe09ee7e86e1f4912779910210fa45e695a72f5dfba34d07ae4d6e082e5e68d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 60fe73920e231ec1efc1514c51beba12e48d55de8da2e716dce78ffc16914927107921d5435946be38b40918328000694fce0fab108005c762da863da2150ecd
|
7
|
+
data.tar.gz: cee3ecaa29da09f5b093e9c92ab5e5e2791c538d5e73f1014e21c45a097b10bb12bba587b36deb2d4f7ea8d5f4cc5d6ff9553ea966679d556023ee878b16016a
|
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.12
|
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.12.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.12.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.12'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -191,6 +191,8 @@ Class | Method | HTTP request | Description
|
|
191
191
|
*UltracartClient::ConversationApi* | [**get_pbx_time_ranges**](docs/ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
|
192
192
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailbox**](docs/ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
|
193
193
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
|
194
|
+
*UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
195
|
+
*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
194
196
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
195
197
|
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
196
198
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
@@ -222,6 +224,8 @@ Class | Method | HTTP request | Description
|
|
222
224
|
*UltracartClient::ConversationApi* | [**update_pbx_time_based**](docs/ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased
|
223
225
|
*UltracartClient::ConversationApi* | [**update_pbx_time_range**](docs/ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
|
224
226
|
*UltracartClient::ConversationApi* | [**update_pbx_voicemail_mailbox**](docs/ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
|
227
|
+
*UltracartClient::ConversationApi* | [**update_virtual_agent_budget**](docs/ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget
|
228
|
+
*UltracartClient::ConversationApi* | [**update_virtual_agent_capabilities**](docs/ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
|
225
229
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
226
230
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
227
231
|
*UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
|
@@ -813,6 +817,10 @@ Class | Method | HTTP request | Description
|
|
813
817
|
- [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
|
814
818
|
- [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
|
815
819
|
- [UltracartClient::ConversationTwilioAccount](docs/ConversationTwilioAccount.md)
|
820
|
+
- [UltracartClient::ConversationVirtualAgentBudget](docs/ConversationVirtualAgentBudget.md)
|
821
|
+
- [UltracartClient::ConversationVirtualAgentBudgetResponse](docs/ConversationVirtualAgentBudgetResponse.md)
|
822
|
+
- [UltracartClient::ConversationVirtualAgentCapabilities](docs/ConversationVirtualAgentCapabilities.md)
|
823
|
+
- [UltracartClient::ConversationVirtualAgentCapabilitiesResponse](docs/ConversationVirtualAgentCapabilitiesResponse.md)
|
816
824
|
- [UltracartClient::ConversationWebchatContext](docs/ConversationWebchatContext.md)
|
817
825
|
- [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
|
818
826
|
- [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
|
@@ -1524,6 +1532,8 @@ Not every change is committed to every SDK.
|
|
1524
1532
|
|
1525
1533
|
| Version | Date | Comments |
|
1526
1534
|
| --: | :-: | --- |
|
1535
|
+
| 3.11.12 | 05/19/2025 | conversations - AI agent capabilities method |
|
1536
|
+
| 3.11.11 | 05/19/2025 | conversations - virtual AI budgets |
|
1527
1537
|
| 3.11.10 | 05/06/2025 | conversation - ConversationAgentProfile.user_id added for agent profiles call |
|
1528
1538
|
| 3.11.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |
|
1529
1539
|
| 3.11.8 | 04/22/2025 | order property fields for created_by and created_dts |
|
data/docs/ConversationApi.md
CHANGED
@@ -57,6 +57,8 @@ Method | HTTP request | Description
|
|
57
57
|
[**get_pbx_time_ranges**](ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
|
58
58
|
[**get_pbx_voicemail_mailbox**](ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
|
59
59
|
[**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
|
60
|
+
[**get_virtual_agent_budget**](ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
61
|
+
[**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
60
62
|
[**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
61
63
|
[**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
62
64
|
[**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
@@ -88,6 +90,8 @@ Method | HTTP request | Description
|
|
88
90
|
[**update_pbx_time_based**](ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased
|
89
91
|
[**update_pbx_time_range**](ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
|
90
92
|
[**update_pbx_voicemail_mailbox**](ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
|
93
|
+
[**update_virtual_agent_budget**](ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget
|
94
|
+
[**update_virtual_agent_capabilities**](ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
|
91
95
|
|
92
96
|
|
93
97
|
# **delete_conversation_canned_message**
|
@@ -2658,6 +2662,96 @@ This endpoint does not need any parameter.
|
|
2658
2662
|
|
2659
2663
|
|
2660
2664
|
|
2665
|
+
# **get_virtual_agent_budget**
|
2666
|
+
> ConversationVirtualAgentBudgetResponse get_virtual_agent_budget
|
2667
|
+
|
2668
|
+
Get virtual agent budget
|
2669
|
+
|
2670
|
+
Retrieve virtual agent budget
|
2671
|
+
|
2672
|
+
### Example
|
2673
|
+
```ruby
|
2674
|
+
# load the gem
|
2675
|
+
require 'ultracart_api'
|
2676
|
+
|
2677
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2678
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2679
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
2680
|
+
|
2681
|
+
|
2682
|
+
|
2683
|
+
begin
|
2684
|
+
#Get virtual agent budget
|
2685
|
+
result = api_instance.get_virtual_agent_budget
|
2686
|
+
p result
|
2687
|
+
rescue UltracartClient::ApiError => e
|
2688
|
+
puts "Exception when calling ConversationApi->get_virtual_agent_budget: #{e}"
|
2689
|
+
end
|
2690
|
+
```
|
2691
|
+
|
2692
|
+
### Parameters
|
2693
|
+
This endpoint does not need any parameter.
|
2694
|
+
|
2695
|
+
### Return type
|
2696
|
+
|
2697
|
+
[**ConversationVirtualAgentBudgetResponse**](ConversationVirtualAgentBudgetResponse.md)
|
2698
|
+
|
2699
|
+
### Authorization
|
2700
|
+
|
2701
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2702
|
+
|
2703
|
+
### HTTP request headers
|
2704
|
+
|
2705
|
+
- **Content-Type**: application/json
|
2706
|
+
- **Accept**: application/json
|
2707
|
+
|
2708
|
+
|
2709
|
+
|
2710
|
+
# **get_virtual_agent_capabilities**
|
2711
|
+
> ConversationVirtualAgentCapabilitiesResponse get_virtual_agent_capabilities
|
2712
|
+
|
2713
|
+
Get virtual agent capabilities
|
2714
|
+
|
2715
|
+
Retrieve virtual agent capabilities
|
2716
|
+
|
2717
|
+
### Example
|
2718
|
+
```ruby
|
2719
|
+
# load the gem
|
2720
|
+
require 'ultracart_api'
|
2721
|
+
|
2722
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2723
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2724
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
2725
|
+
|
2726
|
+
|
2727
|
+
|
2728
|
+
begin
|
2729
|
+
#Get virtual agent capabilities
|
2730
|
+
result = api_instance.get_virtual_agent_capabilities
|
2731
|
+
p result
|
2732
|
+
rescue UltracartClient::ApiError => e
|
2733
|
+
puts "Exception when calling ConversationApi->get_virtual_agent_capabilities: #{e}"
|
2734
|
+
end
|
2735
|
+
```
|
2736
|
+
|
2737
|
+
### Parameters
|
2738
|
+
This endpoint does not need any parameter.
|
2739
|
+
|
2740
|
+
### Return type
|
2741
|
+
|
2742
|
+
[**ConversationVirtualAgentCapabilitiesResponse**](ConversationVirtualAgentCapabilitiesResponse.md)
|
2743
|
+
|
2744
|
+
### Authorization
|
2745
|
+
|
2746
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2747
|
+
|
2748
|
+
### HTTP request headers
|
2749
|
+
|
2750
|
+
- **Content-Type**: application/json
|
2751
|
+
- **Accept**: application/json
|
2752
|
+
|
2753
|
+
|
2754
|
+
|
2661
2755
|
# **insert_conversation_canned_message**
|
2662
2756
|
> ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
|
2663
2757
|
|
@@ -4243,3 +4337,103 @@ Name | Type | Description | Notes
|
|
4243
4337
|
|
4244
4338
|
|
4245
4339
|
|
4340
|
+
# **update_virtual_agent_budget**
|
4341
|
+
> ConversationVirtualAgentBudgetResponse update_virtual_agent_budget(virtual_agent_budget)
|
4342
|
+
|
4343
|
+
Update virtual agent budget
|
4344
|
+
|
4345
|
+
Update virtual agent budget
|
4346
|
+
|
4347
|
+
### Example
|
4348
|
+
```ruby
|
4349
|
+
# load the gem
|
4350
|
+
require 'ultracart_api'
|
4351
|
+
|
4352
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
4353
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
4354
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
4355
|
+
|
4356
|
+
|
4357
|
+
virtual_agent_budget = UltracartClient::ConversationVirtualAgentBudget.new # ConversationVirtualAgentBudget | Virtual Agent Budget
|
4358
|
+
|
4359
|
+
|
4360
|
+
begin
|
4361
|
+
#Update virtual agent budget
|
4362
|
+
result = api_instance.update_virtual_agent_budget(virtual_agent_budget)
|
4363
|
+
p result
|
4364
|
+
rescue UltracartClient::ApiError => e
|
4365
|
+
puts "Exception when calling ConversationApi->update_virtual_agent_budget: #{e}"
|
4366
|
+
end
|
4367
|
+
```
|
4368
|
+
|
4369
|
+
### Parameters
|
4370
|
+
|
4371
|
+
Name | Type | Description | Notes
|
4372
|
+
------------- | ------------- | ------------- | -------------
|
4373
|
+
**virtual_agent_budget** | [**ConversationVirtualAgentBudget**](ConversationVirtualAgentBudget.md)| Virtual Agent Budget |
|
4374
|
+
|
4375
|
+
### Return type
|
4376
|
+
|
4377
|
+
[**ConversationVirtualAgentBudgetResponse**](ConversationVirtualAgentBudgetResponse.md)
|
4378
|
+
|
4379
|
+
### Authorization
|
4380
|
+
|
4381
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
4382
|
+
|
4383
|
+
### HTTP request headers
|
4384
|
+
|
4385
|
+
- **Content-Type**: application/json
|
4386
|
+
- **Accept**: application/json
|
4387
|
+
|
4388
|
+
|
4389
|
+
|
4390
|
+
# **update_virtual_agent_capabilities**
|
4391
|
+
> ConversationVirtualAgentCapabilitiesResponse update_virtual_agent_capabilities(virtual_agent_capabilities)
|
4392
|
+
|
4393
|
+
Update virtual agent capabilities
|
4394
|
+
|
4395
|
+
Update virtual agent capabilities
|
4396
|
+
|
4397
|
+
### Example
|
4398
|
+
```ruby
|
4399
|
+
# load the gem
|
4400
|
+
require 'ultracart_api'
|
4401
|
+
|
4402
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
4403
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
4404
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
4405
|
+
|
4406
|
+
|
4407
|
+
virtual_agent_capabilities = UltracartClient::ConversationVirtualAgentCapabilities.new # ConversationVirtualAgentCapabilities | Virtual Agent Capabilities
|
4408
|
+
|
4409
|
+
|
4410
|
+
begin
|
4411
|
+
#Update virtual agent capabilities
|
4412
|
+
result = api_instance.update_virtual_agent_capabilities(virtual_agent_capabilities)
|
4413
|
+
p result
|
4414
|
+
rescue UltracartClient::ApiError => e
|
4415
|
+
puts "Exception when calling ConversationApi->update_virtual_agent_capabilities: #{e}"
|
4416
|
+
end
|
4417
|
+
```
|
4418
|
+
|
4419
|
+
### Parameters
|
4420
|
+
|
4421
|
+
Name | Type | Description | Notes
|
4422
|
+
------------- | ------------- | ------------- | -------------
|
4423
|
+
**virtual_agent_capabilities** | [**ConversationVirtualAgentCapabilities**](ConversationVirtualAgentCapabilities.md)| Virtual Agent Capabilities |
|
4424
|
+
|
4425
|
+
### Return type
|
4426
|
+
|
4427
|
+
[**ConversationVirtualAgentCapabilitiesResponse**](ConversationVirtualAgentCapabilitiesResponse.md)
|
4428
|
+
|
4429
|
+
### Authorization
|
4430
|
+
|
4431
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
4432
|
+
|
4433
|
+
### HTTP request headers
|
4434
|
+
|
4435
|
+
- **Content-Type**: application/json
|
4436
|
+
- **Accept**: application/json
|
4437
|
+
|
4438
|
+
|
4439
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::ConversationVirtualAgentBudget
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**budget_daily** | **Float** | | [optional]
|
7
|
+
**budget_monthly** | **Float** | | [optional]
|
8
|
+
**used_daily** | **Float** | | [optional]
|
9
|
+
**used_monthly** | **Float** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationVirtualAgentBudgetResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**budget** | [**ConversationVirtualAgentBudget**](ConversationVirtualAgentBudget.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,16 @@
|
|
1
|
+
# UltracartClient::ConversationVirtualAgentCapabilities
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cancel_subscription** | **BOOLEAN** | | [optional]
|
7
|
+
**delay_subscription** | **BOOLEAN** | | [optional]
|
8
|
+
**lookup_order_information** | **BOOLEAN** | | [optional]
|
9
|
+
**lookup_subscription_information** | **BOOLEAN** | | [optional]
|
10
|
+
**open_support_ticket** | **BOOLEAN** | | [optional]
|
11
|
+
**pause_subscription** | **BOOLEAN** | | [optional]
|
12
|
+
**resume_subscription** | **BOOLEAN** | | [optional]
|
13
|
+
**transfer_chat_to_live_agent** | **BOOLEAN** | | [optional]
|
14
|
+
**update_subscription_credit_card** | **BOOLEAN** | | [optional]
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationVirtualAgentCapabilitiesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**capabilities** | [**ConversationVirtualAgentCapabilities**](ConversationVirtualAgentCapabilities.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
|
+
|
@@ -2851,6 +2851,104 @@ module UltracartClient
|
|
2851
2851
|
end
|
2852
2852
|
return data, status_code, headers
|
2853
2853
|
end
|
2854
|
+
# Get virtual agent budget
|
2855
|
+
# Retrieve virtual agent budget
|
2856
|
+
# @param [Hash] opts the optional parameters
|
2857
|
+
# @return [ConversationVirtualAgentBudgetResponse]
|
2858
|
+
def get_virtual_agent_budget(opts = {})
|
2859
|
+
data, _status_code, _headers = get_virtual_agent_budget_with_http_info(opts)
|
2860
|
+
data
|
2861
|
+
end
|
2862
|
+
|
2863
|
+
# Get virtual agent budget
|
2864
|
+
# Retrieve virtual agent budget
|
2865
|
+
# @param [Hash] opts the optional parameters
|
2866
|
+
# @return [Array<(ConversationVirtualAgentBudgetResponse, Fixnum, Hash)>] ConversationVirtualAgentBudgetResponse data, response status code and response headers
|
2867
|
+
def get_virtual_agent_budget_with_http_info(opts = {})
|
2868
|
+
if @api_client.config.debugging
|
2869
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_virtual_agent_budget ...'
|
2870
|
+
end
|
2871
|
+
# resource path
|
2872
|
+
local_var_path = '/conversation/virtualagent/budget'
|
2873
|
+
|
2874
|
+
# query parameters
|
2875
|
+
query_params = {}
|
2876
|
+
|
2877
|
+
# header parameters
|
2878
|
+
header_params = {}
|
2879
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2880
|
+
# HTTP header 'Accept' (if needed)
|
2881
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2882
|
+
# HTTP header 'Content-Type'
|
2883
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2884
|
+
|
2885
|
+
# form parameters
|
2886
|
+
form_params = {}
|
2887
|
+
|
2888
|
+
# http body (model)
|
2889
|
+
post_body = nil
|
2890
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
2891
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2892
|
+
:header_params => header_params,
|
2893
|
+
:query_params => query_params,
|
2894
|
+
:form_params => form_params,
|
2895
|
+
:body => post_body,
|
2896
|
+
:auth_names => auth_names,
|
2897
|
+
:return_type => 'ConversationVirtualAgentBudgetResponse')
|
2898
|
+
if @api_client.config.debugging
|
2899
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_virtual_agent_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2900
|
+
end
|
2901
|
+
return data, status_code, headers
|
2902
|
+
end
|
2903
|
+
# Get virtual agent capabilities
|
2904
|
+
# Retrieve virtual agent capabilities
|
2905
|
+
# @param [Hash] opts the optional parameters
|
2906
|
+
# @return [ConversationVirtualAgentCapabilitiesResponse]
|
2907
|
+
def get_virtual_agent_capabilities(opts = {})
|
2908
|
+
data, _status_code, _headers = get_virtual_agent_capabilities_with_http_info(opts)
|
2909
|
+
data
|
2910
|
+
end
|
2911
|
+
|
2912
|
+
# Get virtual agent capabilities
|
2913
|
+
# Retrieve virtual agent capabilities
|
2914
|
+
# @param [Hash] opts the optional parameters
|
2915
|
+
# @return [Array<(ConversationVirtualAgentCapabilitiesResponse, Fixnum, Hash)>] ConversationVirtualAgentCapabilitiesResponse data, response status code and response headers
|
2916
|
+
def get_virtual_agent_capabilities_with_http_info(opts = {})
|
2917
|
+
if @api_client.config.debugging
|
2918
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_virtual_agent_capabilities ...'
|
2919
|
+
end
|
2920
|
+
# resource path
|
2921
|
+
local_var_path = '/conversation/virtualagent/capabilities'
|
2922
|
+
|
2923
|
+
# query parameters
|
2924
|
+
query_params = {}
|
2925
|
+
|
2926
|
+
# header parameters
|
2927
|
+
header_params = {}
|
2928
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2929
|
+
# HTTP header 'Accept' (if needed)
|
2930
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2931
|
+
# HTTP header 'Content-Type'
|
2932
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2933
|
+
|
2934
|
+
# form parameters
|
2935
|
+
form_params = {}
|
2936
|
+
|
2937
|
+
# http body (model)
|
2938
|
+
post_body = nil
|
2939
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
2940
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2941
|
+
:header_params => header_params,
|
2942
|
+
:query_params => query_params,
|
2943
|
+
:form_params => form_params,
|
2944
|
+
:body => post_body,
|
2945
|
+
:auth_names => auth_names,
|
2946
|
+
:return_type => 'ConversationVirtualAgentCapabilitiesResponse')
|
2947
|
+
if @api_client.config.debugging
|
2948
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_virtual_agent_capabilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2949
|
+
end
|
2950
|
+
return data, status_code, headers
|
2951
|
+
end
|
2854
2952
|
# Insert a canned message
|
2855
2953
|
# Insert a canned message
|
2856
2954
|
# @param canned_message Canned message
|
@@ -4628,5 +4726,115 @@ module UltracartClient
|
|
4628
4726
|
end
|
4629
4727
|
return data, status_code, headers
|
4630
4728
|
end
|
4729
|
+
# Update virtual agent budget
|
4730
|
+
# Update virtual agent budget
|
4731
|
+
# @param virtual_agent_budget Virtual Agent Budget
|
4732
|
+
# @param [Hash] opts the optional parameters
|
4733
|
+
# @return [ConversationVirtualAgentBudgetResponse]
|
4734
|
+
def update_virtual_agent_budget(virtual_agent_budget, opts = {})
|
4735
|
+
data, _status_code, _headers = update_virtual_agent_budget_with_http_info(virtual_agent_budget, opts)
|
4736
|
+
data
|
4737
|
+
end
|
4738
|
+
|
4739
|
+
# Update virtual agent budget
|
4740
|
+
# Update virtual agent budget
|
4741
|
+
# @param virtual_agent_budget Virtual Agent Budget
|
4742
|
+
# @param [Hash] opts the optional parameters
|
4743
|
+
# @return [Array<(ConversationVirtualAgentBudgetResponse, Fixnum, Hash)>] ConversationVirtualAgentBudgetResponse data, response status code and response headers
|
4744
|
+
def update_virtual_agent_budget_with_http_info(virtual_agent_budget, opts = {})
|
4745
|
+
if @api_client.config.debugging
|
4746
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_virtual_agent_budget ...'
|
4747
|
+
end
|
4748
|
+
# verify the required parameter 'virtual_agent_budget' is set
|
4749
|
+
if @api_client.config.client_side_validation && virtual_agent_budget.nil?
|
4750
|
+
fail ArgumentError, "Missing the required parameter 'virtual_agent_budget' when calling ConversationApi.update_virtual_agent_budget"
|
4751
|
+
end
|
4752
|
+
# resource path
|
4753
|
+
local_var_path = '/conversation/virtualagent/budget'
|
4754
|
+
|
4755
|
+
# query parameters
|
4756
|
+
query_params = {}
|
4757
|
+
|
4758
|
+
# header parameters
|
4759
|
+
header_params = {}
|
4760
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
4761
|
+
# HTTP header 'Accept' (if needed)
|
4762
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4763
|
+
# HTTP header 'Content-Type'
|
4764
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4765
|
+
|
4766
|
+
# form parameters
|
4767
|
+
form_params = {}
|
4768
|
+
|
4769
|
+
# http body (model)
|
4770
|
+
post_body = @api_client.object_to_http_body(virtual_agent_budget)
|
4771
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
4772
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
4773
|
+
:header_params => header_params,
|
4774
|
+
:query_params => query_params,
|
4775
|
+
:form_params => form_params,
|
4776
|
+
:body => post_body,
|
4777
|
+
:auth_names => auth_names,
|
4778
|
+
:return_type => 'ConversationVirtualAgentBudgetResponse')
|
4779
|
+
if @api_client.config.debugging
|
4780
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_virtual_agent_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4781
|
+
end
|
4782
|
+
return data, status_code, headers
|
4783
|
+
end
|
4784
|
+
# Update virtual agent capabilities
|
4785
|
+
# Update virtual agent capabilities
|
4786
|
+
# @param virtual_agent_capabilities Virtual Agent Capabilities
|
4787
|
+
# @param [Hash] opts the optional parameters
|
4788
|
+
# @return [ConversationVirtualAgentCapabilitiesResponse]
|
4789
|
+
def update_virtual_agent_capabilities(virtual_agent_capabilities, opts = {})
|
4790
|
+
data, _status_code, _headers = update_virtual_agent_capabilities_with_http_info(virtual_agent_capabilities, opts)
|
4791
|
+
data
|
4792
|
+
end
|
4793
|
+
|
4794
|
+
# Update virtual agent capabilities
|
4795
|
+
# Update virtual agent capabilities
|
4796
|
+
# @param virtual_agent_capabilities Virtual Agent Capabilities
|
4797
|
+
# @param [Hash] opts the optional parameters
|
4798
|
+
# @return [Array<(ConversationVirtualAgentCapabilitiesResponse, Fixnum, Hash)>] ConversationVirtualAgentCapabilitiesResponse data, response status code and response headers
|
4799
|
+
def update_virtual_agent_capabilities_with_http_info(virtual_agent_capabilities, opts = {})
|
4800
|
+
if @api_client.config.debugging
|
4801
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_virtual_agent_capabilities ...'
|
4802
|
+
end
|
4803
|
+
# verify the required parameter 'virtual_agent_capabilities' is set
|
4804
|
+
if @api_client.config.client_side_validation && virtual_agent_capabilities.nil?
|
4805
|
+
fail ArgumentError, "Missing the required parameter 'virtual_agent_capabilities' when calling ConversationApi.update_virtual_agent_capabilities"
|
4806
|
+
end
|
4807
|
+
# resource path
|
4808
|
+
local_var_path = '/conversation/virtualagent/capabilities'
|
4809
|
+
|
4810
|
+
# query parameters
|
4811
|
+
query_params = {}
|
4812
|
+
|
4813
|
+
# header parameters
|
4814
|
+
header_params = {}
|
4815
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
4816
|
+
# HTTP header 'Accept' (if needed)
|
4817
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4818
|
+
# HTTP header 'Content-Type'
|
4819
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4820
|
+
|
4821
|
+
# form parameters
|
4822
|
+
form_params = {}
|
4823
|
+
|
4824
|
+
# http body (model)
|
4825
|
+
post_body = @api_client.object_to_http_body(virtual_agent_capabilities)
|
4826
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
4827
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
4828
|
+
:header_params => header_params,
|
4829
|
+
:query_params => query_params,
|
4830
|
+
:form_params => form_params,
|
4831
|
+
:body => post_body,
|
4832
|
+
:auth_names => auth_names,
|
4833
|
+
:return_type => 'ConversationVirtualAgentCapabilitiesResponse')
|
4834
|
+
if @api_client.config.debugging
|
4835
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_virtual_agent_capabilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4836
|
+
end
|
4837
|
+
return data, status_code, headers
|
4838
|
+
end
|
4631
4839
|
end
|
4632
4840
|
end
|