ultracart_api 4.1.29 → 4.1.30
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 +10 -2
- data/docs/ConversationApi.md +220 -0
- data/docs/ConversationMcpServer.md +32 -0
- data/docs/ConversationMcpServerResponse.md +26 -0
- data/docs/ConversationMcpServersResponse.md +26 -0
- data/docs/ItemShipping.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +290 -0
- data/lib/ultracart_api/models/conversation_mcp_server.rb +324 -0
- data/lib/ultracart_api/models/conversation_mcp_server_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_mcp_servers_response.rb +258 -0
- data/lib/ultracart_api/models/item_shipping.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +3 -0
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7a845e391cdd0dcac524c109083ccccd725addd41909f047385503d42b1f6dc1
|
|
4
|
+
data.tar.gz: 51ca82a1a0564032d0ba104e22a47d4303bf001041dc80ef5dca64ba41c91148
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 298aff841a5034cb910c2f1edb1b8f84bbe0cbc0183cef5a217304d3438b52306a848751cbfc57de761014440fe6e07e41fae94c424bd7bf82a6209354fc77e4
|
|
7
|
+
data.tar.gz: e510059249aee5a9a68d2dcac1697b4b474e8886704549af31481e7b53129418ec424335fe59cf936998892b83d83f3416908b87a523603229e63ba3d19f82ce
|
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.30
|
|
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.30'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -144,6 +144,8 @@ Class | Method | HTTP request | Description
|
|
|
144
144
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
145
145
|
*UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
|
146
146
|
*UltracartClient::ConversationApi* | [**get_agent_profile_knowledge_base**](docs/ConversationApi.md#get_agent_profile_knowledge_base) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base | Get the list of knowledge base documents associated with this agent profile
|
|
147
|
+
*UltracartClient::ConversationApi* | [**get_agent_profile_mcp**](docs/ConversationApi.md#get_agent_profile_mcp) | **GET** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Get an MCP server associated with this agent
|
|
148
|
+
*UltracartClient::ConversationApi* | [**get_agent_profile_mcps**](docs/ConversationApi.md#get_agent_profile_mcps) | **GET** /conversation/agent/profiles/{user_id}/mcps | Get the list of MCP servers associated with this agent
|
|
147
149
|
*UltracartClient::ConversationApi* | [**get_agent_profiles**](docs/ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
|
|
148
150
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
149
151
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
@@ -188,6 +190,7 @@ Class | Method | HTTP request | Description
|
|
|
188
190
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
|
189
191
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
|
190
192
|
*UltracartClient::ConversationApi* | [**insert_agent_profile_knowledge_base_document**](docs/ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document
|
|
193
|
+
*UltracartClient::ConversationApi* | [**insert_agent_profile_mcp**](docs/ConversationApi.md#insert_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps | Insert an agent MCP server
|
|
191
194
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
|
192
195
|
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
|
193
196
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
|
@@ -207,6 +210,7 @@ Class | Method | HTTP request | Description
|
|
|
207
210
|
*UltracartClient::ConversationApi* | [**sms_unsubscribe_conversation**](docs/ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
|
|
208
211
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
209
212
|
*UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
|
213
|
+
*UltracartClient::ConversationApi* | [**update_agent_profile_mcp**](docs/ConversationApi.md#update_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Update an agent MCP server
|
|
210
214
|
*UltracartClient::ConversationApi* | [**update_conversation_canned_message**](docs/ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
|
|
211
215
|
*UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
|
|
212
216
|
*UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
|
|
@@ -784,6 +788,9 @@ Class | Method | HTTP request | Description
|
|
|
784
788
|
- [UltracartClient::ConversationLocationCountry](docs/ConversationLocationCountry.md)
|
|
785
789
|
- [UltracartClient::ConversationLocationStateProvince](docs/ConversationLocationStateProvince.md)
|
|
786
790
|
- [UltracartClient::ConversationLocationsResponse](docs/ConversationLocationsResponse.md)
|
|
791
|
+
- [UltracartClient::ConversationMcpServer](docs/ConversationMcpServer.md)
|
|
792
|
+
- [UltracartClient::ConversationMcpServerResponse](docs/ConversationMcpServerResponse.md)
|
|
793
|
+
- [UltracartClient::ConversationMcpServersResponse](docs/ConversationMcpServersResponse.md)
|
|
787
794
|
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
|
788
795
|
- [UltracartClient::ConversationMessageTranslation](docs/ConversationMessageTranslation.md)
|
|
789
796
|
- [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
|
@@ -1589,6 +1596,7 @@ Not every change is committed to every SDK.
|
|
|
1589
1596
|
|
|
1590
1597
|
| Version | Date | Comments |
|
|
1591
1598
|
| --: | :-: | --- |
|
|
1599
|
+
| 4.1.30 | 11/19/2025 | conversation - AI agent MCP server configuration methods |
|
|
1592
1600
|
| 4.1.29 | 11/13/2025 | conversations - AI capabilities flag for generate coupon |
|
|
1593
1601
|
| 4.1.28 | 11/07/2025 | OrderApi.assignToAffiliate |
|
|
1594
1602
|
| 4.1.27 | 11/06/2025 | conversation ai knowledge base changes |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -19,6 +19,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
19
19
|
| [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive |
|
|
20
20
|
| [**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile |
|
|
21
21
|
| [**get_agent_profile_knowledge_base**](ConversationApi.md#get_agent_profile_knowledge_base) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base | Get the list of knowledge base documents associated with this agent profile |
|
|
22
|
+
| [**get_agent_profile_mcp**](ConversationApi.md#get_agent_profile_mcp) | **GET** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Get an MCP server associated with this agent |
|
|
23
|
+
| [**get_agent_profile_mcps**](ConversationApi.md#get_agent_profile_mcps) | **GET** /conversation/agent/profiles/{user_id}/mcps | Get the list of MCP servers associated with this agent |
|
|
22
24
|
| [**get_agent_profiles**](ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles |
|
|
23
25
|
| [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization |
|
|
24
26
|
| [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation |
|
|
@@ -63,6 +65,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
63
65
|
| [**get_virtual_agent_budget**](ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget |
|
|
64
66
|
| [**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities |
|
|
65
67
|
| [**insert_agent_profile_knowledge_base_document**](ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document |
|
|
68
|
+
| [**insert_agent_profile_mcp**](ConversationApi.md#insert_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps | Insert an agent MCP server |
|
|
66
69
|
| [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message |
|
|
67
70
|
| [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department |
|
|
68
71
|
| [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement |
|
|
@@ -82,6 +85,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
82
85
|
| [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation |
|
|
83
86
|
| [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
|
|
84
87
|
| [**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile |
|
|
88
|
+
| [**update_agent_profile_mcp**](ConversationApi.md#update_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Update an agent MCP server |
|
|
85
89
|
| [**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message |
|
|
86
90
|
| [**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department |
|
|
87
91
|
| [**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement |
|
|
@@ -904,6 +908,113 @@ end
|
|
|
904
908
|
- **Accept**: application/json
|
|
905
909
|
|
|
906
910
|
|
|
911
|
+
## get_agent_profile_mcp
|
|
912
|
+
|
|
913
|
+
> <ConversationMcpServerResponse> get_agent_profile_mcp(user_id, mcp_server_uuid)
|
|
914
|
+
|
|
915
|
+
Get an MCP server associated with this agent
|
|
916
|
+
|
|
917
|
+
Retrieve MCP server associated with this agent
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
### Examples
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
(No example for this operation).
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
#### Using the get_agent_profile_mcp_with_http_info variant
|
|
927
|
+
|
|
928
|
+
This returns an Array which contains the response data, status code and headers.
|
|
929
|
+
|
|
930
|
+
> <Array(<ConversationMcpServerResponse>, Integer, Hash)> get_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid)
|
|
931
|
+
|
|
932
|
+
```ruby
|
|
933
|
+
begin
|
|
934
|
+
# Get an MCP server associated with this agent
|
|
935
|
+
data, status_code, headers = api_instance.get_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid)
|
|
936
|
+
p status_code # => 2xx
|
|
937
|
+
p headers # => { ... }
|
|
938
|
+
p data # => <ConversationMcpServerResponse>
|
|
939
|
+
rescue UltracartClient::ApiError => e
|
|
940
|
+
puts "Error when calling ConversationApi->get_agent_profile_mcp_with_http_info: #{e}"
|
|
941
|
+
end
|
|
942
|
+
```
|
|
943
|
+
|
|
944
|
+
### Parameters
|
|
945
|
+
|
|
946
|
+
| Name | Type | Description | Notes |
|
|
947
|
+
| ---- | ---- | ----------- | ----- |
|
|
948
|
+
| **user_id** | **Integer** | | |
|
|
949
|
+
| **mcp_server_uuid** | **String** | | |
|
|
950
|
+
|
|
951
|
+
### Return type
|
|
952
|
+
|
|
953
|
+
[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
|
|
954
|
+
|
|
955
|
+
### Authorization
|
|
956
|
+
|
|
957
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
958
|
+
|
|
959
|
+
### HTTP request headers
|
|
960
|
+
|
|
961
|
+
- **Content-Type**: Not defined
|
|
962
|
+
- **Accept**: application/json
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
## get_agent_profile_mcps
|
|
966
|
+
|
|
967
|
+
> <ConversationMcpServersResponse> get_agent_profile_mcps(user_id)
|
|
968
|
+
|
|
969
|
+
Get the list of MCP servers associated with this agent
|
|
970
|
+
|
|
971
|
+
Retrieve MCP servers associated with this agent
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
### Examples
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
(No example for this operation).
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
#### Using the get_agent_profile_mcps_with_http_info variant
|
|
981
|
+
|
|
982
|
+
This returns an Array which contains the response data, status code and headers.
|
|
983
|
+
|
|
984
|
+
> <Array(<ConversationMcpServersResponse>, Integer, Hash)> get_agent_profile_mcps_with_http_info(user_id)
|
|
985
|
+
|
|
986
|
+
```ruby
|
|
987
|
+
begin
|
|
988
|
+
# Get the list of MCP servers associated with this agent
|
|
989
|
+
data, status_code, headers = api_instance.get_agent_profile_mcps_with_http_info(user_id)
|
|
990
|
+
p status_code # => 2xx
|
|
991
|
+
p headers # => { ... }
|
|
992
|
+
p data # => <ConversationMcpServersResponse>
|
|
993
|
+
rescue UltracartClient::ApiError => e
|
|
994
|
+
puts "Error when calling ConversationApi->get_agent_profile_mcps_with_http_info: #{e}"
|
|
995
|
+
end
|
|
996
|
+
```
|
|
997
|
+
|
|
998
|
+
### Parameters
|
|
999
|
+
|
|
1000
|
+
| Name | Type | Description | Notes |
|
|
1001
|
+
| ---- | ---- | ----------- | ----- |
|
|
1002
|
+
| **user_id** | **Integer** | | |
|
|
1003
|
+
|
|
1004
|
+
### Return type
|
|
1005
|
+
|
|
1006
|
+
[**ConversationMcpServersResponse**](ConversationMcpServersResponse.md)
|
|
1007
|
+
|
|
1008
|
+
### Authorization
|
|
1009
|
+
|
|
1010
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1011
|
+
|
|
1012
|
+
### HTTP request headers
|
|
1013
|
+
|
|
1014
|
+
- **Content-Type**: Not defined
|
|
1015
|
+
- **Accept**: application/json
|
|
1016
|
+
|
|
1017
|
+
|
|
907
1018
|
## get_agent_profiles
|
|
908
1019
|
|
|
909
1020
|
> <ConversationAgentProfilesResponse> get_agent_profiles
|
|
@@ -3244,6 +3355,60 @@ end
|
|
|
3244
3355
|
- **Accept**: application/json
|
|
3245
3356
|
|
|
3246
3357
|
|
|
3358
|
+
## insert_agent_profile_mcp
|
|
3359
|
+
|
|
3360
|
+
> <ConversationMcpServerResponse> insert_agent_profile_mcp(user_id, mcp_server)
|
|
3361
|
+
|
|
3362
|
+
Insert an agent MCP server
|
|
3363
|
+
|
|
3364
|
+
Insert an agent MCP server
|
|
3365
|
+
|
|
3366
|
+
|
|
3367
|
+
### Examples
|
|
3368
|
+
|
|
3369
|
+
|
|
3370
|
+
(No example for this operation).
|
|
3371
|
+
|
|
3372
|
+
|
|
3373
|
+
#### Using the insert_agent_profile_mcp_with_http_info variant
|
|
3374
|
+
|
|
3375
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3376
|
+
|
|
3377
|
+
> <Array(<ConversationMcpServerResponse>, Integer, Hash)> insert_agent_profile_mcp_with_http_info(user_id, mcp_server)
|
|
3378
|
+
|
|
3379
|
+
```ruby
|
|
3380
|
+
begin
|
|
3381
|
+
# Insert an agent MCP server
|
|
3382
|
+
data, status_code, headers = api_instance.insert_agent_profile_mcp_with_http_info(user_id, mcp_server)
|
|
3383
|
+
p status_code # => 2xx
|
|
3384
|
+
p headers # => { ... }
|
|
3385
|
+
p data # => <ConversationMcpServerResponse>
|
|
3386
|
+
rescue UltracartClient::ApiError => e
|
|
3387
|
+
puts "Error when calling ConversationApi->insert_agent_profile_mcp_with_http_info: #{e}"
|
|
3388
|
+
end
|
|
3389
|
+
```
|
|
3390
|
+
|
|
3391
|
+
### Parameters
|
|
3392
|
+
|
|
3393
|
+
| Name | Type | Description | Notes |
|
|
3394
|
+
| ---- | ---- | ----------- | ----- |
|
|
3395
|
+
| **user_id** | **Integer** | | |
|
|
3396
|
+
| **mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md) | MCP Server | |
|
|
3397
|
+
|
|
3398
|
+
### Return type
|
|
3399
|
+
|
|
3400
|
+
[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
|
|
3401
|
+
|
|
3402
|
+
### Authorization
|
|
3403
|
+
|
|
3404
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3405
|
+
|
|
3406
|
+
### HTTP request headers
|
|
3407
|
+
|
|
3408
|
+
- **Content-Type**: application/json
|
|
3409
|
+
- **Accept**: application/json
|
|
3410
|
+
|
|
3411
|
+
|
|
3247
3412
|
## insert_conversation_canned_message
|
|
3248
3413
|
|
|
3249
3414
|
> <ConversationCannedMessageResponse> insert_conversation_canned_message(canned_message)
|
|
@@ -4272,6 +4437,61 @@ end
|
|
|
4272
4437
|
- **Accept**: application/json
|
|
4273
4438
|
|
|
4274
4439
|
|
|
4440
|
+
## update_agent_profile_mcp
|
|
4441
|
+
|
|
4442
|
+
> <ConversationMcpServerResponse> update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server)
|
|
4443
|
+
|
|
4444
|
+
Update an agent MCP server
|
|
4445
|
+
|
|
4446
|
+
Update an agent MCP server
|
|
4447
|
+
|
|
4448
|
+
|
|
4449
|
+
### Examples
|
|
4450
|
+
|
|
4451
|
+
|
|
4452
|
+
(No example for this operation).
|
|
4453
|
+
|
|
4454
|
+
|
|
4455
|
+
#### Using the update_agent_profile_mcp_with_http_info variant
|
|
4456
|
+
|
|
4457
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4458
|
+
|
|
4459
|
+
> <Array(<ConversationMcpServerResponse>, Integer, Hash)> update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server)
|
|
4460
|
+
|
|
4461
|
+
```ruby
|
|
4462
|
+
begin
|
|
4463
|
+
# Update an agent MCP server
|
|
4464
|
+
data, status_code, headers = api_instance.update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server)
|
|
4465
|
+
p status_code # => 2xx
|
|
4466
|
+
p headers # => { ... }
|
|
4467
|
+
p data # => <ConversationMcpServerResponse>
|
|
4468
|
+
rescue UltracartClient::ApiError => e
|
|
4469
|
+
puts "Error when calling ConversationApi->update_agent_profile_mcp_with_http_info: #{e}"
|
|
4470
|
+
end
|
|
4471
|
+
```
|
|
4472
|
+
|
|
4473
|
+
### Parameters
|
|
4474
|
+
|
|
4475
|
+
| Name | Type | Description | Notes |
|
|
4476
|
+
| ---- | ---- | ----------- | ----- |
|
|
4477
|
+
| **user_id** | **Integer** | | |
|
|
4478
|
+
| **mcp_server_uuid** | **String** | | |
|
|
4479
|
+
| **mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md) | MCP Server | |
|
|
4480
|
+
|
|
4481
|
+
### Return type
|
|
4482
|
+
|
|
4483
|
+
[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
|
|
4484
|
+
|
|
4485
|
+
### Authorization
|
|
4486
|
+
|
|
4487
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4488
|
+
|
|
4489
|
+
### HTTP request headers
|
|
4490
|
+
|
|
4491
|
+
- **Content-Type**: application/json
|
|
4492
|
+
- **Accept**: application/json
|
|
4493
|
+
|
|
4494
|
+
|
|
4275
4495
|
## update_conversation_canned_message
|
|
4276
4496
|
|
|
4277
4497
|
> <ConversationCannedMessageResponse> update_conversation_canned_message(conversation_canned_message_oid, canned_message)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::ConversationMcpServer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **auth_method** | **String** | Authorization Method | [optional] |
|
|
8
|
+
| **basic_password** | **String** | Basic password | [optional] |
|
|
9
|
+
| **basic_user_name** | **String** | Basic user name | [optional] |
|
|
10
|
+
| **header_name** | **String** | Header name | [optional] |
|
|
11
|
+
| **header_value** | **String** | Header value | [optional] |
|
|
12
|
+
| **mcp_server_uuid** | **String** | UUID of the MCP server configuration | [optional] |
|
|
13
|
+
| **priority** | **Integer** | Priority on which the MCP server tools are incorporated into the model. Lower number comes first | [optional] |
|
|
14
|
+
| **url** | **String** | URL to the MCP server (must be https) | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::ConversationMcpServer.new(
|
|
22
|
+
auth_method: null,
|
|
23
|
+
basic_password: null,
|
|
24
|
+
basic_user_name: null,
|
|
25
|
+
header_name: null,
|
|
26
|
+
header_value: null,
|
|
27
|
+
mcp_server_uuid: null,
|
|
28
|
+
priority: null,
|
|
29
|
+
url: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationMcpServerResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
|
+
| **mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.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::ConversationMcpServerResponse.new(
|
|
19
|
+
error: null,
|
|
20
|
+
mcp_server: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationMcpServersResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
|
+
| **mcp_servers** | [**Array<ConversationMcpServer>**](ConversationMcpServer.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::ConversationMcpServersResponse.new(
|
|
19
|
+
error: null,
|
|
20
|
+
mcp_servers: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/ItemShipping.md
CHANGED
|
@@ -28,6 +28,7 @@
|
|
|
28
28
|
| **freight_class** | **String** | Freight class | [optional] |
|
|
29
29
|
| **hazmat** | **Boolean** | Hazardous material | [optional] |
|
|
30
30
|
| **hold_for_transmission** | **Boolean** | Hold for transmission | [optional] |
|
|
31
|
+
| **include_on_packing_slip** | **Boolean** | Force this item onto the packing slip even if there is no weight. | [optional] |
|
|
31
32
|
| **made_to_order** | **Boolean** | True if this item is made to order | [optional] |
|
|
32
33
|
| **made_to_order_lead_time** | **Integer** | Number of days lead time it takes to make the item before ite can ship | [optional] |
|
|
33
34
|
| **max_days_time_in_transit** | **Integer** | Maximum days allowed in transit | [optional] |
|
|
@@ -84,6 +85,7 @@ instance = UltracartClient::ItemShipping.new(
|
|
|
84
85
|
freight_class: null,
|
|
85
86
|
hazmat: null,
|
|
86
87
|
hold_for_transmission: null,
|
|
88
|
+
include_on_packing_slip: null,
|
|
87
89
|
made_to_order: null,
|
|
88
90
|
made_to_order_lead_time: null,
|
|
89
91
|
max_days_time_in_transit: null,
|