ultracart_api 3.11.29 → 3.11.31
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 +15 -4
- data/docs/ConversationApi.md +266 -0
- data/docs/ConversationMcpServer.md +15 -0
- data/docs/ConversationMcpServerResponse.md +12 -0
- data/docs/ConversationMcpServerToolsResponse.md +12 -0
- data/docs/ConversationMcpServersResponse.md +12 -0
- data/docs/ItemShipping.md +1 -0
- data/lib/ultracart_api/api/conversation_api.rb +298 -0
- data/lib/ultracart_api/models/conversation_mcp_server.rb +289 -0
- data/lib/ultracart_api/models/conversation_mcp_server_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_mcp_server_tools_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_mcp_servers_response.rb +223 -0
- data/lib/ultracart_api/models/item_shipping.rb +11 -1
- 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: 64f8c1d7d8aaee41012e2b5eb7f58b7b3bd112c8c519bccd2446bf82979bc7c1
|
|
4
|
+
data.tar.gz: 418be57ad7d637ae9cbe541875cf4a14221b93026ae20d65adf519d5273219a6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a13f629c10f32898918431ff7e95c8804c5b02956a99bc26c5cc73995814446f16ebac8b5913964ad6b453f0977ff89ed420fdcb00e370feb3e808c9ade54de0
|
|
7
|
+
data.tar.gz: f1b308bfb8afc2382b371ddb6556d69ba927701a1750b68b7adcb82839218f76c8cb262da35081f676e807b7ce79445ea0ece823649f7d45eea1dd34c720d676
|
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.31
|
|
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.31.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.31.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.31'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -134,6 +134,7 @@ Class | Method | HTTP request | Description
|
|
|
134
134
|
*UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
|
|
135
135
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
|
136
136
|
*UltracartClient::ConversationApi* | [**delete_agent_profile_knowledge_base_document**](docs/ConversationApi.md#delete_agent_profile_knowledge_base_document) | **DELETE** /conversation/agent/profiles/{user_id}/knowledge_base/{document_uuid} | Delete a knowledge base document
|
|
137
|
+
*UltracartClient::ConversationApi* | [**delete_agent_profile_mcp**](docs/ConversationApi.md#delete_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Delete an agent MCP server
|
|
137
138
|
*UltracartClient::ConversationApi* | [**delete_conversation_canned_message**](docs/ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
|
138
139
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
|
139
140
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
|
@@ -148,6 +149,9 @@ Class | Method | HTTP request | Description
|
|
|
148
149
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
149
150
|
*UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
|
150
151
|
*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
|
|
152
|
+
*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
|
|
153
|
+
*UltracartClient::ConversationApi* | [**get_agent_profile_mcp_tools**](docs/ConversationApi.md#get_agent_profile_mcp_tools) | **GET** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}/tools | Get the tools available from the MCP server
|
|
154
|
+
*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
|
|
151
155
|
*UltracartClient::ConversationApi* | [**get_agent_profiles**](docs/ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
|
|
152
156
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
153
157
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
@@ -192,6 +196,7 @@ Class | Method | HTTP request | Description
|
|
|
192
196
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
|
193
197
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
|
194
198
|
*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
|
|
199
|
+
*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
|
|
195
200
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
|
196
201
|
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
|
197
202
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
|
@@ -789,6 +794,10 @@ Class | Method | HTTP request | Description
|
|
|
789
794
|
- [UltracartClient::ConversationLocationCountry](docs/ConversationLocationCountry.md)
|
|
790
795
|
- [UltracartClient::ConversationLocationStateProvince](docs/ConversationLocationStateProvince.md)
|
|
791
796
|
- [UltracartClient::ConversationLocationsResponse](docs/ConversationLocationsResponse.md)
|
|
797
|
+
- [UltracartClient::ConversationMcpServer](docs/ConversationMcpServer.md)
|
|
798
|
+
- [UltracartClient::ConversationMcpServerResponse](docs/ConversationMcpServerResponse.md)
|
|
799
|
+
- [UltracartClient::ConversationMcpServerToolsResponse](docs/ConversationMcpServerToolsResponse.md)
|
|
800
|
+
- [UltracartClient::ConversationMcpServersResponse](docs/ConversationMcpServersResponse.md)
|
|
792
801
|
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
|
793
802
|
- [UltracartClient::ConversationMessageTranslation](docs/ConversationMessageTranslation.md)
|
|
794
803
|
- [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
|
@@ -1591,6 +1600,8 @@ Not every change is committed to every SDK.
|
|
|
1591
1600
|
|
|
1592
1601
|
| Version | Date | Comments |
|
|
1593
1602
|
| --: | :-: | --- |
|
|
1603
|
+
| 3.11.31 | 11/20/2025 | conversation - AI agent mcp server tools function |
|
|
1604
|
+
| 3.11.30 | 11/19/2025 | conversation - AI agent MCP server configuration methods |
|
|
1594
1605
|
| 3.11.29 | 11/13/2025 | conversations - AI capabilities flag for generate coupon |
|
|
1595
1606
|
| 3.11.28 | 11/07/2025 | OrderApi.assignToAffiliate |
|
|
1596
1607
|
| 3.11.27 | 11/06/2025 | conversation ai knowledge base changes |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**delete_agent_profile_knowledge_base_document**](ConversationApi.md#delete_agent_profile_knowledge_base_document) | **DELETE** /conversation/agent/profiles/{user_id}/knowledge_base/{document_uuid} | Delete a knowledge base document
|
|
8
|
+
[**delete_agent_profile_mcp**](ConversationApi.md#delete_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Delete an agent MCP server
|
|
8
9
|
[**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
|
9
10
|
[**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
|
10
11
|
[**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
|
@@ -19,6 +20,9 @@ Method | HTTP request | Description
|
|
|
19
20
|
[**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
20
21
|
[**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
|
21
22
|
[**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
|
|
23
|
+
[**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
|
|
24
|
+
[**get_agent_profile_mcp_tools**](ConversationApi.md#get_agent_profile_mcp_tools) | **GET** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}/tools | Get the tools available from the MCP server
|
|
25
|
+
[**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
26
|
[**get_agent_profiles**](ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
|
|
23
27
|
[**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
24
28
|
[**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
@@ -63,6 +67,7 @@ Method | HTTP request | Description
|
|
|
63
67
|
[**get_virtual_agent_budget**](ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
|
64
68
|
[**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
|
65
69
|
[**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
|
|
70
|
+
[**insert_agent_profile_mcp**](ConversationApi.md#insert_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps | Insert an agent MCP server
|
|
66
71
|
[**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
|
67
72
|
[**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
|
68
73
|
[**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
|
@@ -151,6 +156,58 @@ Name | Type | Description | Notes
|
|
|
151
156
|
|
|
152
157
|
|
|
153
158
|
|
|
159
|
+
# **delete_agent_profile_mcp**
|
|
160
|
+
> delete_agent_profile_mcp(user_id, mcp_server_uuid)
|
|
161
|
+
|
|
162
|
+
Delete an agent MCP server
|
|
163
|
+
|
|
164
|
+
Delete an agent MCP server
|
|
165
|
+
|
|
166
|
+
### Example
|
|
167
|
+
```ruby
|
|
168
|
+
# load the gem
|
|
169
|
+
require 'ultracart_api'
|
|
170
|
+
|
|
171
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
172
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
173
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
user_id = 56 # Integer |
|
|
177
|
+
|
|
178
|
+
mcp_server_uuid = 'mcp_server_uuid_example' # String |
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
begin
|
|
182
|
+
#Delete an agent MCP server
|
|
183
|
+
api_instance.delete_agent_profile_mcp(user_id, mcp_server_uuid)
|
|
184
|
+
rescue UltracartClient::ApiError => e
|
|
185
|
+
puts "Exception when calling ConversationApi->delete_agent_profile_mcp: #{e}"
|
|
186
|
+
end
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Parameters
|
|
190
|
+
|
|
191
|
+
Name | Type | Description | Notes
|
|
192
|
+
------------- | ------------- | ------------- | -------------
|
|
193
|
+
**user_id** | **Integer**| |
|
|
194
|
+
**mcp_server_uuid** | **String**| |
|
|
195
|
+
|
|
196
|
+
### Return type
|
|
197
|
+
|
|
198
|
+
nil (empty response body)
|
|
199
|
+
|
|
200
|
+
### Authorization
|
|
201
|
+
|
|
202
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
203
|
+
|
|
204
|
+
### HTTP request headers
|
|
205
|
+
|
|
206
|
+
- **Content-Type**: application/json
|
|
207
|
+
- **Accept**: application/json
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
154
211
|
# **delete_conversation_canned_message**
|
|
155
212
|
> delete_conversation_canned_message(conversation_canned_message_oid)
|
|
156
213
|
|
|
@@ -838,6 +895,162 @@ Name | Type | Description | Notes
|
|
|
838
895
|
|
|
839
896
|
|
|
840
897
|
|
|
898
|
+
# **get_agent_profile_mcp**
|
|
899
|
+
> ConversationMcpServerResponse get_agent_profile_mcp(user_id, mcp_server_uuid)
|
|
900
|
+
|
|
901
|
+
Get an MCP server associated with this agent
|
|
902
|
+
|
|
903
|
+
Retrieve MCP server associated with this agent
|
|
904
|
+
|
|
905
|
+
### Example
|
|
906
|
+
```ruby
|
|
907
|
+
# load the gem
|
|
908
|
+
require 'ultracart_api'
|
|
909
|
+
|
|
910
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
911
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
912
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
user_id = 56 # Integer |
|
|
916
|
+
|
|
917
|
+
mcp_server_uuid = 'mcp_server_uuid_example' # String |
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
begin
|
|
921
|
+
#Get an MCP server associated with this agent
|
|
922
|
+
result = api_instance.get_agent_profile_mcp(user_id, mcp_server_uuid)
|
|
923
|
+
p result
|
|
924
|
+
rescue UltracartClient::ApiError => e
|
|
925
|
+
puts "Exception when calling ConversationApi->get_agent_profile_mcp: #{e}"
|
|
926
|
+
end
|
|
927
|
+
```
|
|
928
|
+
|
|
929
|
+
### Parameters
|
|
930
|
+
|
|
931
|
+
Name | Type | Description | Notes
|
|
932
|
+
------------- | ------------- | ------------- | -------------
|
|
933
|
+
**user_id** | **Integer**| |
|
|
934
|
+
**mcp_server_uuid** | **String**| |
|
|
935
|
+
|
|
936
|
+
### Return type
|
|
937
|
+
|
|
938
|
+
[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
|
|
939
|
+
|
|
940
|
+
### Authorization
|
|
941
|
+
|
|
942
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
943
|
+
|
|
944
|
+
### HTTP request headers
|
|
945
|
+
|
|
946
|
+
- **Content-Type**: application/json
|
|
947
|
+
- **Accept**: application/json
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
# **get_agent_profile_mcp_tools**
|
|
952
|
+
> ConversationMcpServerToolsResponse get_agent_profile_mcp_tools(user_id, mcp_server_uuid)
|
|
953
|
+
|
|
954
|
+
Get the tools available from the MCP server
|
|
955
|
+
|
|
956
|
+
Get the tools available from the MCP server
|
|
957
|
+
|
|
958
|
+
### Example
|
|
959
|
+
```ruby
|
|
960
|
+
# load the gem
|
|
961
|
+
require 'ultracart_api'
|
|
962
|
+
|
|
963
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
964
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
965
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
user_id = 56 # Integer |
|
|
969
|
+
|
|
970
|
+
mcp_server_uuid = 'mcp_server_uuid_example' # String |
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
begin
|
|
974
|
+
#Get the tools available from the MCP server
|
|
975
|
+
result = api_instance.get_agent_profile_mcp_tools(user_id, mcp_server_uuid)
|
|
976
|
+
p result
|
|
977
|
+
rescue UltracartClient::ApiError => e
|
|
978
|
+
puts "Exception when calling ConversationApi->get_agent_profile_mcp_tools: #{e}"
|
|
979
|
+
end
|
|
980
|
+
```
|
|
981
|
+
|
|
982
|
+
### Parameters
|
|
983
|
+
|
|
984
|
+
Name | Type | Description | Notes
|
|
985
|
+
------------- | ------------- | ------------- | -------------
|
|
986
|
+
**user_id** | **Integer**| |
|
|
987
|
+
**mcp_server_uuid** | **String**| |
|
|
988
|
+
|
|
989
|
+
### Return type
|
|
990
|
+
|
|
991
|
+
[**ConversationMcpServerToolsResponse**](ConversationMcpServerToolsResponse.md)
|
|
992
|
+
|
|
993
|
+
### Authorization
|
|
994
|
+
|
|
995
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
996
|
+
|
|
997
|
+
### HTTP request headers
|
|
998
|
+
|
|
999
|
+
- **Content-Type**: application/json
|
|
1000
|
+
- **Accept**: application/json
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
# **get_agent_profile_mcps**
|
|
1005
|
+
> ConversationMcpServersResponse get_agent_profile_mcps(user_id)
|
|
1006
|
+
|
|
1007
|
+
Get the list of MCP servers associated with this agent
|
|
1008
|
+
|
|
1009
|
+
Retrieve MCP servers associated with this agent
|
|
1010
|
+
|
|
1011
|
+
### Example
|
|
1012
|
+
```ruby
|
|
1013
|
+
# load the gem
|
|
1014
|
+
require 'ultracart_api'
|
|
1015
|
+
|
|
1016
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1017
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1018
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
user_id = 56 # Integer |
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
begin
|
|
1025
|
+
#Get the list of MCP servers associated with this agent
|
|
1026
|
+
result = api_instance.get_agent_profile_mcps(user_id)
|
|
1027
|
+
p result
|
|
1028
|
+
rescue UltracartClient::ApiError => e
|
|
1029
|
+
puts "Exception when calling ConversationApi->get_agent_profile_mcps: #{e}"
|
|
1030
|
+
end
|
|
1031
|
+
```
|
|
1032
|
+
|
|
1033
|
+
### Parameters
|
|
1034
|
+
|
|
1035
|
+
Name | Type | Description | Notes
|
|
1036
|
+
------------- | ------------- | ------------- | -------------
|
|
1037
|
+
**user_id** | **Integer**| |
|
|
1038
|
+
|
|
1039
|
+
### Return type
|
|
1040
|
+
|
|
1041
|
+
[**ConversationMcpServersResponse**](ConversationMcpServersResponse.md)
|
|
1042
|
+
|
|
1043
|
+
### Authorization
|
|
1044
|
+
|
|
1045
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1046
|
+
|
|
1047
|
+
### HTTP request headers
|
|
1048
|
+
|
|
1049
|
+
- **Content-Type**: application/json
|
|
1050
|
+
- **Accept**: application/json
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
|
|
841
1054
|
# **get_agent_profiles**
|
|
842
1055
|
> ConversationAgentProfilesResponse get_agent_profiles
|
|
843
1056
|
|
|
@@ -2965,6 +3178,59 @@ Name | Type | Description | Notes
|
|
|
2965
3178
|
|
|
2966
3179
|
|
|
2967
3180
|
|
|
3181
|
+
# **insert_agent_profile_mcp**
|
|
3182
|
+
> ConversationMcpServerResponse insert_agent_profile_mcp(user_id, mcp_server)
|
|
3183
|
+
|
|
3184
|
+
Insert an agent MCP server
|
|
3185
|
+
|
|
3186
|
+
Insert an agent MCP server
|
|
3187
|
+
|
|
3188
|
+
### Example
|
|
3189
|
+
```ruby
|
|
3190
|
+
# load the gem
|
|
3191
|
+
require 'ultracart_api'
|
|
3192
|
+
|
|
3193
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
3194
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
3195
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
3196
|
+
|
|
3197
|
+
|
|
3198
|
+
user_id = 56 # Integer |
|
|
3199
|
+
|
|
3200
|
+
mcp_server = UltracartClient::ConversationMcpServer.new # ConversationMcpServer | MCP Server
|
|
3201
|
+
|
|
3202
|
+
|
|
3203
|
+
begin
|
|
3204
|
+
#Insert an agent MCP server
|
|
3205
|
+
result = api_instance.insert_agent_profile_mcp(user_id, mcp_server)
|
|
3206
|
+
p result
|
|
3207
|
+
rescue UltracartClient::ApiError => e
|
|
3208
|
+
puts "Exception when calling ConversationApi->insert_agent_profile_mcp: #{e}"
|
|
3209
|
+
end
|
|
3210
|
+
```
|
|
3211
|
+
|
|
3212
|
+
### Parameters
|
|
3213
|
+
|
|
3214
|
+
Name | Type | Description | Notes
|
|
3215
|
+
------------- | ------------- | ------------- | -------------
|
|
3216
|
+
**user_id** | **Integer**| |
|
|
3217
|
+
**mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md)| MCP Server |
|
|
3218
|
+
|
|
3219
|
+
### Return type
|
|
3220
|
+
|
|
3221
|
+
[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
|
|
3222
|
+
|
|
3223
|
+
### Authorization
|
|
3224
|
+
|
|
3225
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3226
|
+
|
|
3227
|
+
### HTTP request headers
|
|
3228
|
+
|
|
3229
|
+
- **Content-Type**: application/json
|
|
3230
|
+
- **Accept**: application/json
|
|
3231
|
+
|
|
3232
|
+
|
|
3233
|
+
|
|
2968
3234
|
# **insert_conversation_canned_message**
|
|
2969
3235
|
> ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
|
|
2970
3236
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# UltracartClient::ConversationMcpServer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**auth_method** | **String** | Authorization Method | [optional]
|
|
7
|
+
**basic_password** | **String** | Basic password | [optional]
|
|
8
|
+
**basic_user_name** | **String** | Basic user name | [optional]
|
|
9
|
+
**header_name** | **String** | Header name | [optional]
|
|
10
|
+
**header_value** | **String** | Header value | [optional]
|
|
11
|
+
**mcp_server_uuid** | **String** | UUID of the MCP server configuration | [optional]
|
|
12
|
+
**priority** | **Integer** | Priority on which the MCP server tools are incorporated into the model. Lower number comes first | [optional]
|
|
13
|
+
**url** | **String** | URL to the MCP server (must be https) | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationMcpServerResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
+
**mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md) | | [optional]
|
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationMcpServerToolsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
9
|
+
**tools_json** | **String** | | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationMcpServersResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
+
**mcp_servers** | [**Array<ConversationMcpServer>**](ConversationMcpServer.md) | | [optional]
|
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/ItemShipping.md
CHANGED
|
@@ -27,6 +27,7 @@ Name | Type | Description | Notes
|
|
|
27
27
|
**freight_class** | **String** | Freight class | [optional]
|
|
28
28
|
**hazmat** | **BOOLEAN** | Hazardous material | [optional]
|
|
29
29
|
**hold_for_transmission** | **BOOLEAN** | Hold for transmission | [optional]
|
|
30
|
+
**include_on_packing_slip** | **BOOLEAN** | Force this item onto the packing slip even if there is no weight. | [optional]
|
|
30
31
|
**made_to_order** | **BOOLEAN** | True if this item is made to order | [optional]
|
|
31
32
|
**made_to_order_lead_time** | **Integer** | Number of days lead time it takes to make the item before ite can ship | [optional]
|
|
32
33
|
**max_days_time_in_transit** | **Integer** | Maximum days allowed in transit | [optional]
|