ultracart_api 3.11.28 → 3.11.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e2b4677a03b2103fa194b40ebb76de6d6a3e1f73f8fdba966fb3933746d7be4
-  data.tar.gz: e8e4d31945bfd34d06c080aad8fa06a441f2d4f2c9818bd7ec094815676d97ea
+  metadata.gz: 50e86579960cc0fb8e178e6ece69e1b9405e2162f9348d1ad8d39e0d0a406a7f
+  data.tar.gz: 792a24d8ccba205aa55b4b3d91a5dd3793db5a10661e606a7deb7283e13d6808
 SHA512:
-  metadata.gz: 9186c2fe6a2abf34ca8e44c79486d50c19273158b0a72cbdda7e484a8aae6bc1a3c5a84c2004580c23532aba8e1c02051880551ac4ee7c33a606eb08ff2145c7
-  data.tar.gz: 600e0b573b33e0116ddf9a7d7e963dcdbb5f0bd070123b6141870db6c8d2b6f45f0f7d22bd11ab557ab7833f7fb613d0cf1cb40bb5f2a961fd3665f8b3f67936
+  metadata.gz: d2b8a674c6c5b423328dd5a9765b2590e4dc1db7ab418ad017745f4de5ef30496c65dac19f54192072a9cdd3de2f751e767eaf836d98a2f07322d1920f482733
+  data.tar.gz: b64d95d41c945990b79412add044d59bf6b47c5af94acec7eb39b7f8f17b487457397efcde809ee6fcd034caa8685efc2134c11d6764a7caed4a5eb8ec399341

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.11.28
+- Package version: 3.11.30
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.11.28.gem
+gem install ./ultracart_api-3.11.30.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.28.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.30.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.11.28'
+    gem 'ultracart_api', '~> 3.11.30'
 
 ### Install from Git
 
@@ -148,6 +148,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
 *UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
 *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
+*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
+*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
 *UltracartClient::ConversationApi* | [**get_agent_profiles**](docs/ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
 *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
@@ -192,6 +194,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
 *UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
 *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
+*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
 *UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
 *UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
 *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
@@ -211,6 +214,7 @@ Class | Method | HTTP request | Description
 *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
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 *UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
+*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
 *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
 *UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
 *UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
@@ -789,6 +793,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationLocationCountry](docs/ConversationLocationCountry.md)
  - [UltracartClient::ConversationLocationStateProvince](docs/ConversationLocationStateProvince.md)
  - [UltracartClient::ConversationLocationsResponse](docs/ConversationLocationsResponse.md)
+ - [UltracartClient::ConversationMcpServer](docs/ConversationMcpServer.md)
+ - [UltracartClient::ConversationMcpServerResponse](docs/ConversationMcpServerResponse.md)
+ - [UltracartClient::ConversationMcpServersResponse](docs/ConversationMcpServersResponse.md)
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
  - [UltracartClient::ConversationMessageTranslation](docs/ConversationMessageTranslation.md)
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
@@ -1591,6 +1598,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.30 | 11/19/2025 | conversation - AI agent MCP server configuration methods |
+| 3.11.29 | 11/13/2025 | conversations - AI capabilities flag for generate coupon |
 | 3.11.28 | 11/07/2025 | OrderApi.assignToAffiliate |
 | 3.11.27 | 11/06/2025 | conversation ai knowledge base changes |
 | 3.11.26 | 10/20/2025 | conversation api bug fixes |

data/docs/ConversationApi.md

@@ -19,6 +19,8 @@ Method | HTTP request | Description
 [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
 [**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
 [**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
+[**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
+[**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
 [**get_agent_profiles**](ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
 [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
@@ -63,6 +65,7 @@ Method | HTTP request | Description
 [**get_virtual_agent_budget**](ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
 [**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
 [**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
+[**insert_agent_profile_mcp**](ConversationApi.md#insert_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps | Insert an agent MCP server
 [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
 [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
 [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
@@ -82,6 +85,7 @@ Method | HTTP request | Description
 [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
 [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 [**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
+[**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
 [**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
 [**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
 [**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
@@ -838,6 +842,109 @@ Name | Type | Description  | Notes
 
 
 
+# **get_agent_profile_mcp**
+> ConversationMcpServerResponse get_agent_profile_mcp(user_id, mcp_server_uuid)
+
+Get an MCP server associated with this agent
+
+Retrieve MCP server associated with this agent 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+user_id = 56 # Integer | 
+
+mcp_server_uuid = 'mcp_server_uuid_example' # String | 
+
+
+begin
+  #Get an MCP server associated with this agent
+  result = api_instance.get_agent_profile_mcp(user_id, mcp_server_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_agent_profile_mcp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**|  | 
+ **mcp_server_uuid** | **String**|  | 
+
+### Return type
+
+[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_agent_profile_mcps**
+> ConversationMcpServersResponse get_agent_profile_mcps(user_id)
+
+Get the list of MCP servers associated with this agent
+
+Retrieve MCP servers associated with this agent 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+user_id = 56 # Integer | 
+
+
+begin
+  #Get the list of MCP servers associated with this agent
+  result = api_instance.get_agent_profile_mcps(user_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_agent_profile_mcps: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**|  | 
+
+### Return type
+
+[**ConversationMcpServersResponse**](ConversationMcpServersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_agent_profiles**
 > ConversationAgentProfilesResponse get_agent_profiles
 
@@ -2965,6 +3072,59 @@ Name | Type | Description  | Notes
 
 
 
+# **insert_agent_profile_mcp**
+> ConversationMcpServerResponse insert_agent_profile_mcp(user_id, mcp_server)
+
+Insert an agent MCP server
+
+Insert an agent MCP server 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+user_id = 56 # Integer | 
+
+mcp_server = UltracartClient::ConversationMcpServer.new # ConversationMcpServer | MCP Server
+
+
+begin
+  #Insert an agent MCP server
+  result = api_instance.insert_agent_profile_mcp(user_id, mcp_server)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->insert_agent_profile_mcp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**|  | 
+ **mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md)| MCP Server | 
+
+### Return type
+
+[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **insert_conversation_canned_message**
 > ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
 
@@ -3915,6 +4075,62 @@ Name | Type | Description  | Notes
 
 
 
+# **update_agent_profile_mcp**
+> ConversationMcpServerResponse update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server)
+
+Update an agent MCP server
+
+Update an agent MCP server 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+user_id = 56 # Integer | 
+
+mcp_server_uuid = 'mcp_server_uuid_example' # String | 
+
+mcp_server = UltracartClient::ConversationMcpServer.new # ConversationMcpServer | MCP Server
+
+
+begin
+  #Update an agent MCP server
+  result = api_instance.update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->update_agent_profile_mcp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**|  | 
+ **mcp_server_uuid** | **String**|  | 
+ **mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md)| MCP Server | 
+
+### Return type
+
+[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_conversation_canned_message**
 > ConversationCannedMessageResponse update_conversation_canned_message(conversation_canned_message_oid, canned_message)
 

data/docs/ConversationMcpServer.md

@@ -0,0 +1,15 @@
+# UltracartClient::ConversationMcpServer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_method** | **String** | Authorization Method | [optional] 
+**basic_password** | **String** | Basic password | [optional] 
+**basic_user_name** | **String** | Basic user name | [optional] 
+**header_name** | **String** | Header name | [optional] 
+**header_value** | **String** | Header value | [optional] 
+**mcp_server_uuid** | **String** | UUID of the MCP server configuration | [optional] 
+**priority** | **Integer** | Priority on which the MCP server tools are incorporated into the model.  Lower number comes first | [optional] 
+**url** | **String** | URL to the MCP server (must be https) | [optional] 
+
+

data/docs/ConversationMcpServerResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationMcpServerResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ConversationMcpServersResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationMcpServersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**mcp_servers** | [**Array<ConversationMcpServer>**](ConversationMcpServer.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ConversationMessage.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **merchant_id** | **String** |  | [optional] 
 **message_dts** | **String** | Message date/time | [optional] 
 **message_epoch** | **Integer** | Message epoch milliseconds | [optional] 
+**message_type** | **String** |  | [optional] 
 **translations** | [**Array<ConversationMessageTranslation>**](ConversationMessageTranslation.md) |  | [optional] 
 **transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) |  | [optional] 
 **type** | **String** | Message type | [optional] 

data/docs/ConversationVirtualAgentCapabilities.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **access_storefront_and_item** | **BOOLEAN** | Permission flag to allow this Agent access to the storefront and item information. | [optional] 
 **cancel_subscription** | **BOOLEAN** |  | [optional] 
 **delay_subscription** | **BOOLEAN** |  | [optional] 
+**generate_coupon** | **BOOLEAN** | Permission flag to allow this Agent to generate coupons based upon the agent prompt instructions | [optional] 
 **lookup_order_information** | **BOOLEAN** |  | [optional] 
 **lookup_subscription_information** | **BOOLEAN** |  | [optional] 
 **open_support_ticket** | **BOOLEAN** |  | [optional] 

data/docs/ItemShipping.md

@@ -27,6 +27,7 @@ Name | Type | Description | Notes
 **freight_class** | **String** | Freight class | [optional] 
 **hazmat** | **BOOLEAN** | Hazardous material | [optional] 
 **hold_for_transmission** | **BOOLEAN** | Hold for transmission | [optional] 
+**include_on_packing_slip** | **BOOLEAN** | Force this item onto the packing slip even if there is no weight. | [optional] 
 **made_to_order** | **BOOLEAN** | True if this item is made to order | [optional] 
 **made_to_order_lead_time** | **Integer** | Number of days lead time it takes to make the item before ite can ship | [optional] 
 **max_days_time_in_transit** | **Integer** | Maximum days allowed in transit | [optional]