ultracart_api 4.1.29 → 4.1.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 +13 -2
- data/docs/ConversationApi.md +274 -0
- data/docs/ConversationMcpServer.md +32 -0
- data/docs/ConversationMcpServerResponse.md +26 -0
- data/docs/ConversationMcpServerToolsResponse.md +26 -0
- data/docs/ConversationMcpServersResponse.md +26 -0
- data/docs/ItemShipping.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +349 -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_server_tools_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 +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: 356e493e1cda66e4aa916676e6711790fda172e9d69493586ae7325fc5c1cca6
|
|
4
|
+
data.tar.gz: 04fb93d5f314c1fb20bc2ae3749be3d5d85fae4c593cc641c64ea50ed4aafa6f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 03fbcbba8870dafb2f4c8f72523ae129ca12fdd446d60280dcfb3aa883f72970f80bce0c0edf10adfa5de718ff54455111b72ecc6db142c4fd3be9a0af0b6b00
|
|
7
|
+
data.tar.gz: 26b7c1a96af69693302ca8f0bd592e3b9711a35312756111a4c87fc16af056c3e94b50d03bae275ede0f27bce65108cbf04cd40d3f19eb0b0ec0073d5d207047
|
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.31
|
|
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.31'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
|
|
|
130
130
|
*UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
|
|
131
131
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
|
132
132
|
*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
|
|
133
|
+
*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
|
|
133
134
|
*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
|
|
134
135
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
|
135
136
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
|
@@ -144,6 +145,9 @@ Class | Method | HTTP request | Description
|
|
|
144
145
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
145
146
|
*UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
|
146
147
|
*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
|
|
148
|
+
*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
|
|
149
|
+
*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
|
|
150
|
+
*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
151
|
*UltracartClient::ConversationApi* | [**get_agent_profiles**](docs/ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
|
|
148
152
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
149
153
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
@@ -188,6 +192,7 @@ Class | Method | HTTP request | Description
|
|
|
188
192
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
|
189
193
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
|
190
194
|
*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
|
|
195
|
+
*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
196
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
|
192
197
|
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
|
193
198
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
|
@@ -784,6 +789,10 @@ Class | Method | HTTP request | Description
|
|
|
784
789
|
- [UltracartClient::ConversationLocationCountry](docs/ConversationLocationCountry.md)
|
|
785
790
|
- [UltracartClient::ConversationLocationStateProvince](docs/ConversationLocationStateProvince.md)
|
|
786
791
|
- [UltracartClient::ConversationLocationsResponse](docs/ConversationLocationsResponse.md)
|
|
792
|
+
- [UltracartClient::ConversationMcpServer](docs/ConversationMcpServer.md)
|
|
793
|
+
- [UltracartClient::ConversationMcpServerResponse](docs/ConversationMcpServerResponse.md)
|
|
794
|
+
- [UltracartClient::ConversationMcpServerToolsResponse](docs/ConversationMcpServerToolsResponse.md)
|
|
795
|
+
- [UltracartClient::ConversationMcpServersResponse](docs/ConversationMcpServersResponse.md)
|
|
787
796
|
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
|
788
797
|
- [UltracartClient::ConversationMessageTranslation](docs/ConversationMessageTranslation.md)
|
|
789
798
|
- [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
|
@@ -1589,6 +1598,8 @@ Not every change is committed to every SDK.
|
|
|
1589
1598
|
|
|
1590
1599
|
| Version | Date | Comments |
|
|
1591
1600
|
| --: | :-: | --- |
|
|
1601
|
+
| 4.1.31 | 11/20/2025 | conversation - AI agent mcp server tools function |
|
|
1602
|
+
| 4.1.30 | 11/19/2025 | conversation - AI agent MCP server configuration methods |
|
|
1592
1603
|
| 4.1.29 | 11/13/2025 | conversations - AI capabilities flag for generate coupon |
|
|
1593
1604
|
| 4.1.28 | 11/07/2025 | OrderApi.assignToAffiliate |
|
|
1594
1605
|
| 4.1.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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
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 |
|
|
@@ -152,6 +157,60 @@ end
|
|
|
152
157
|
- **Accept**: application/json
|
|
153
158
|
|
|
154
159
|
|
|
160
|
+
## delete_agent_profile_mcp
|
|
161
|
+
|
|
162
|
+
> delete_agent_profile_mcp(user_id, mcp_server_uuid)
|
|
163
|
+
|
|
164
|
+
Delete an agent MCP server
|
|
165
|
+
|
|
166
|
+
Delete an agent MCP server
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
### Examples
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
(No example for this operation).
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
#### Using the delete_agent_profile_mcp_with_http_info variant
|
|
176
|
+
|
|
177
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
178
|
+
|
|
179
|
+
> <Array(nil, Integer, Hash)> delete_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid)
|
|
180
|
+
|
|
181
|
+
```ruby
|
|
182
|
+
begin
|
|
183
|
+
# Delete an agent MCP server
|
|
184
|
+
data, status_code, headers = api_instance.delete_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid)
|
|
185
|
+
p status_code # => 2xx
|
|
186
|
+
p headers # => { ... }
|
|
187
|
+
p data # => nil
|
|
188
|
+
rescue UltracartClient::ApiError => e
|
|
189
|
+
puts "Error when calling ConversationApi->delete_agent_profile_mcp_with_http_info: #{e}"
|
|
190
|
+
end
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Parameters
|
|
194
|
+
|
|
195
|
+
| Name | Type | Description | Notes |
|
|
196
|
+
| ---- | ---- | ----------- | ----- |
|
|
197
|
+
| **user_id** | **Integer** | | |
|
|
198
|
+
| **mcp_server_uuid** | **String** | | |
|
|
199
|
+
|
|
200
|
+
### Return type
|
|
201
|
+
|
|
202
|
+
nil (empty response body)
|
|
203
|
+
|
|
204
|
+
### Authorization
|
|
205
|
+
|
|
206
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
207
|
+
|
|
208
|
+
### HTTP request headers
|
|
209
|
+
|
|
210
|
+
- **Content-Type**: Not defined
|
|
211
|
+
- **Accept**: application/json
|
|
212
|
+
|
|
213
|
+
|
|
155
214
|
## delete_conversation_canned_message
|
|
156
215
|
|
|
157
216
|
> delete_conversation_canned_message(conversation_canned_message_oid)
|
|
@@ -904,6 +963,167 @@ end
|
|
|
904
963
|
- **Accept**: application/json
|
|
905
964
|
|
|
906
965
|
|
|
966
|
+
## get_agent_profile_mcp
|
|
967
|
+
|
|
968
|
+
> <ConversationMcpServerResponse> get_agent_profile_mcp(user_id, mcp_server_uuid)
|
|
969
|
+
|
|
970
|
+
Get an MCP server associated with this agent
|
|
971
|
+
|
|
972
|
+
Retrieve MCP server associated with this agent
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
### Examples
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
(No example for this operation).
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
#### Using the get_agent_profile_mcp_with_http_info variant
|
|
982
|
+
|
|
983
|
+
This returns an Array which contains the response data, status code and headers.
|
|
984
|
+
|
|
985
|
+
> <Array(<ConversationMcpServerResponse>, Integer, Hash)> get_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid)
|
|
986
|
+
|
|
987
|
+
```ruby
|
|
988
|
+
begin
|
|
989
|
+
# Get an MCP server associated with this agent
|
|
990
|
+
data, status_code, headers = api_instance.get_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid)
|
|
991
|
+
p status_code # => 2xx
|
|
992
|
+
p headers # => { ... }
|
|
993
|
+
p data # => <ConversationMcpServerResponse>
|
|
994
|
+
rescue UltracartClient::ApiError => e
|
|
995
|
+
puts "Error when calling ConversationApi->get_agent_profile_mcp_with_http_info: #{e}"
|
|
996
|
+
end
|
|
997
|
+
```
|
|
998
|
+
|
|
999
|
+
### Parameters
|
|
1000
|
+
|
|
1001
|
+
| Name | Type | Description | Notes |
|
|
1002
|
+
| ---- | ---- | ----------- | ----- |
|
|
1003
|
+
| **user_id** | **Integer** | | |
|
|
1004
|
+
| **mcp_server_uuid** | **String** | | |
|
|
1005
|
+
|
|
1006
|
+
### Return type
|
|
1007
|
+
|
|
1008
|
+
[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
|
|
1009
|
+
|
|
1010
|
+
### Authorization
|
|
1011
|
+
|
|
1012
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1013
|
+
|
|
1014
|
+
### HTTP request headers
|
|
1015
|
+
|
|
1016
|
+
- **Content-Type**: Not defined
|
|
1017
|
+
- **Accept**: application/json
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
## get_agent_profile_mcp_tools
|
|
1021
|
+
|
|
1022
|
+
> <ConversationMcpServerToolsResponse> get_agent_profile_mcp_tools(user_id, mcp_server_uuid)
|
|
1023
|
+
|
|
1024
|
+
Get the tools available from the MCP server
|
|
1025
|
+
|
|
1026
|
+
Get the tools available from the MCP server
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
### Examples
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
(No example for this operation).
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
#### Using the get_agent_profile_mcp_tools_with_http_info variant
|
|
1036
|
+
|
|
1037
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1038
|
+
|
|
1039
|
+
> <Array(<ConversationMcpServerToolsResponse>, Integer, Hash)> get_agent_profile_mcp_tools_with_http_info(user_id, mcp_server_uuid)
|
|
1040
|
+
|
|
1041
|
+
```ruby
|
|
1042
|
+
begin
|
|
1043
|
+
# Get the tools available from the MCP server
|
|
1044
|
+
data, status_code, headers = api_instance.get_agent_profile_mcp_tools_with_http_info(user_id, mcp_server_uuid)
|
|
1045
|
+
p status_code # => 2xx
|
|
1046
|
+
p headers # => { ... }
|
|
1047
|
+
p data # => <ConversationMcpServerToolsResponse>
|
|
1048
|
+
rescue UltracartClient::ApiError => e
|
|
1049
|
+
puts "Error when calling ConversationApi->get_agent_profile_mcp_tools_with_http_info: #{e}"
|
|
1050
|
+
end
|
|
1051
|
+
```
|
|
1052
|
+
|
|
1053
|
+
### Parameters
|
|
1054
|
+
|
|
1055
|
+
| Name | Type | Description | Notes |
|
|
1056
|
+
| ---- | ---- | ----------- | ----- |
|
|
1057
|
+
| **user_id** | **Integer** | | |
|
|
1058
|
+
| **mcp_server_uuid** | **String** | | |
|
|
1059
|
+
|
|
1060
|
+
### Return type
|
|
1061
|
+
|
|
1062
|
+
[**ConversationMcpServerToolsResponse**](ConversationMcpServerToolsResponse.md)
|
|
1063
|
+
|
|
1064
|
+
### Authorization
|
|
1065
|
+
|
|
1066
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1067
|
+
|
|
1068
|
+
### HTTP request headers
|
|
1069
|
+
|
|
1070
|
+
- **Content-Type**: Not defined
|
|
1071
|
+
- **Accept**: application/json
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
## get_agent_profile_mcps
|
|
1075
|
+
|
|
1076
|
+
> <ConversationMcpServersResponse> get_agent_profile_mcps(user_id)
|
|
1077
|
+
|
|
1078
|
+
Get the list of MCP servers associated with this agent
|
|
1079
|
+
|
|
1080
|
+
Retrieve MCP servers associated with this agent
|
|
1081
|
+
|
|
1082
|
+
|
|
1083
|
+
### Examples
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
(No example for this operation).
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
#### Using the get_agent_profile_mcps_with_http_info variant
|
|
1090
|
+
|
|
1091
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1092
|
+
|
|
1093
|
+
> <Array(<ConversationMcpServersResponse>, Integer, Hash)> get_agent_profile_mcps_with_http_info(user_id)
|
|
1094
|
+
|
|
1095
|
+
```ruby
|
|
1096
|
+
begin
|
|
1097
|
+
# Get the list of MCP servers associated with this agent
|
|
1098
|
+
data, status_code, headers = api_instance.get_agent_profile_mcps_with_http_info(user_id)
|
|
1099
|
+
p status_code # => 2xx
|
|
1100
|
+
p headers # => { ... }
|
|
1101
|
+
p data # => <ConversationMcpServersResponse>
|
|
1102
|
+
rescue UltracartClient::ApiError => e
|
|
1103
|
+
puts "Error when calling ConversationApi->get_agent_profile_mcps_with_http_info: #{e}"
|
|
1104
|
+
end
|
|
1105
|
+
```
|
|
1106
|
+
|
|
1107
|
+
### Parameters
|
|
1108
|
+
|
|
1109
|
+
| Name | Type | Description | Notes |
|
|
1110
|
+
| ---- | ---- | ----------- | ----- |
|
|
1111
|
+
| **user_id** | **Integer** | | |
|
|
1112
|
+
|
|
1113
|
+
### Return type
|
|
1114
|
+
|
|
1115
|
+
[**ConversationMcpServersResponse**](ConversationMcpServersResponse.md)
|
|
1116
|
+
|
|
1117
|
+
### Authorization
|
|
1118
|
+
|
|
1119
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1120
|
+
|
|
1121
|
+
### HTTP request headers
|
|
1122
|
+
|
|
1123
|
+
- **Content-Type**: Not defined
|
|
1124
|
+
- **Accept**: application/json
|
|
1125
|
+
|
|
1126
|
+
|
|
907
1127
|
## get_agent_profiles
|
|
908
1128
|
|
|
909
1129
|
> <ConversationAgentProfilesResponse> get_agent_profiles
|
|
@@ -3244,6 +3464,60 @@ end
|
|
|
3244
3464
|
- **Accept**: application/json
|
|
3245
3465
|
|
|
3246
3466
|
|
|
3467
|
+
## insert_agent_profile_mcp
|
|
3468
|
+
|
|
3469
|
+
> <ConversationMcpServerResponse> insert_agent_profile_mcp(user_id, mcp_server)
|
|
3470
|
+
|
|
3471
|
+
Insert an agent MCP server
|
|
3472
|
+
|
|
3473
|
+
Insert an agent MCP server
|
|
3474
|
+
|
|
3475
|
+
|
|
3476
|
+
### Examples
|
|
3477
|
+
|
|
3478
|
+
|
|
3479
|
+
(No example for this operation).
|
|
3480
|
+
|
|
3481
|
+
|
|
3482
|
+
#### Using the insert_agent_profile_mcp_with_http_info variant
|
|
3483
|
+
|
|
3484
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3485
|
+
|
|
3486
|
+
> <Array(<ConversationMcpServerResponse>, Integer, Hash)> insert_agent_profile_mcp_with_http_info(user_id, mcp_server)
|
|
3487
|
+
|
|
3488
|
+
```ruby
|
|
3489
|
+
begin
|
|
3490
|
+
# Insert an agent MCP server
|
|
3491
|
+
data, status_code, headers = api_instance.insert_agent_profile_mcp_with_http_info(user_id, mcp_server)
|
|
3492
|
+
p status_code # => 2xx
|
|
3493
|
+
p headers # => { ... }
|
|
3494
|
+
p data # => <ConversationMcpServerResponse>
|
|
3495
|
+
rescue UltracartClient::ApiError => e
|
|
3496
|
+
puts "Error when calling ConversationApi->insert_agent_profile_mcp_with_http_info: #{e}"
|
|
3497
|
+
end
|
|
3498
|
+
```
|
|
3499
|
+
|
|
3500
|
+
### Parameters
|
|
3501
|
+
|
|
3502
|
+
| Name | Type | Description | Notes |
|
|
3503
|
+
| ---- | ---- | ----------- | ----- |
|
|
3504
|
+
| **user_id** | **Integer** | | |
|
|
3505
|
+
| **mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md) | MCP Server | |
|
|
3506
|
+
|
|
3507
|
+
### Return type
|
|
3508
|
+
|
|
3509
|
+
[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
|
|
3510
|
+
|
|
3511
|
+
### Authorization
|
|
3512
|
+
|
|
3513
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3514
|
+
|
|
3515
|
+
### HTTP request headers
|
|
3516
|
+
|
|
3517
|
+
- **Content-Type**: application/json
|
|
3518
|
+
- **Accept**: application/json
|
|
3519
|
+
|
|
3520
|
+
|
|
3247
3521
|
## insert_conversation_canned_message
|
|
3248
3522
|
|
|
3249
3523
|
> <ConversationCannedMessageResponse> insert_conversation_canned_message(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::ConversationMcpServerToolsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
9
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
10
|
+
| **tools_json** | **String** | | [optional] |
|
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::ConversationMcpServerToolsResponse.new(
|
|
19
|
+
error: null,
|
|
20
|
+
metadata: null,
|
|
21
|
+
success: null,
|
|
22
|
+
tools_json: 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,
|