ultracart_api 3.11.31 → 3.11.32
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 +7 -5
- data/docs/ConversationApi.md +58 -1
- data/lib/ultracart_api/api/conversation_api.rb +68 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 255af16bf065068544d5bc95a178818799b97b6044fe7fff5db049352a1776a3
|
|
4
|
+
data.tar.gz: bc66745195d54e57f74c32f3c38c74f1a9b5e032101d9a344b2c775b3c7d654a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9780581ccb408b5f47270edc6339180187cdcbe5e4615330a02bea7afc3f4d7240bac40a12fade425b4872a9325844210328235f74a9e579e12454a0e0044735
|
|
7
|
+
data.tar.gz: 954999404b75ac742574315071fddf5fcd9137d2a6fd104ada76763ce87111691f1b9795b611b02522cc42fbfe8165aee250a6be9831e45a105d0d461f813e1d
|
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.32
|
|
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.32.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.32.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.32'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -134,7 +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) | **
|
|
137
|
+
*UltracartClient::ConversationApi* | [**delete_agent_profile_mcp**](docs/ConversationApi.md#delete_agent_profile_mcp) | **DELETE** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Delete an agent MCP server
|
|
138
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
|
|
139
139
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
|
140
140
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
|
@@ -216,6 +216,7 @@ Class | Method | HTTP request | Description
|
|
|
216
216
|
*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
|
|
217
217
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
218
218
|
*UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
|
219
|
+
*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
|
|
219
220
|
*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
|
|
220
221
|
*UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
|
|
221
222
|
*UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
|
|
@@ -1600,6 +1601,7 @@ Not every change is committed to every SDK.
|
|
|
1600
1601
|
|
|
1601
1602
|
| Version | Date | Comments |
|
|
1602
1603
|
| --: | :-: | --- |
|
|
1604
|
+
| 3.11.32 | 11/20/2025 | conversion api bug fix on incorrect signature |
|
|
1603
1605
|
| 3.11.31 | 11/20/2025 | conversation - AI agent mcp server tools function |
|
|
1604
1606
|
| 3.11.30 | 11/19/2025 | conversation - AI agent MCP server configuration methods |
|
|
1605
1607
|
| 3.11.29 | 11/13/2025 | conversations - AI capabilities flag for generate coupon |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -5,7 +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) | **
|
|
8
|
+
[**delete_agent_profile_mcp**](ConversationApi.md#delete_agent_profile_mcp) | **DELETE** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Delete an agent MCP server
|
|
9
9
|
[**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
|
10
10
|
[**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
|
11
11
|
[**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
|
@@ -87,6 +87,7 @@ Method | HTTP request | Description
|
|
|
87
87
|
[**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
|
|
88
88
|
[**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
89
89
|
[**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
|
90
|
+
[**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
|
|
90
91
|
[**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
|
|
91
92
|
[**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
|
|
92
93
|
[**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
|
|
@@ -4181,6 +4182,62 @@ Name | Type | Description | Notes
|
|
|
4181
4182
|
|
|
4182
4183
|
|
|
4183
4184
|
|
|
4185
|
+
# **update_agent_profile_mcp**
|
|
4186
|
+
> ConversationMcpServerResponse update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server)
|
|
4187
|
+
|
|
4188
|
+
Update an agent MCP server
|
|
4189
|
+
|
|
4190
|
+
Update an agent MCP server
|
|
4191
|
+
|
|
4192
|
+
### Example
|
|
4193
|
+
```ruby
|
|
4194
|
+
# load the gem
|
|
4195
|
+
require 'ultracart_api'
|
|
4196
|
+
|
|
4197
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
4198
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
4199
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
4200
|
+
|
|
4201
|
+
|
|
4202
|
+
user_id = 56 # Integer |
|
|
4203
|
+
|
|
4204
|
+
mcp_server_uuid = 'mcp_server_uuid_example' # String |
|
|
4205
|
+
|
|
4206
|
+
mcp_server = UltracartClient::ConversationMcpServer.new # ConversationMcpServer | MCP Server
|
|
4207
|
+
|
|
4208
|
+
|
|
4209
|
+
begin
|
|
4210
|
+
#Update an agent MCP server
|
|
4211
|
+
result = api_instance.update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server)
|
|
4212
|
+
p result
|
|
4213
|
+
rescue UltracartClient::ApiError => e
|
|
4214
|
+
puts "Exception when calling ConversationApi->update_agent_profile_mcp: #{e}"
|
|
4215
|
+
end
|
|
4216
|
+
```
|
|
4217
|
+
|
|
4218
|
+
### Parameters
|
|
4219
|
+
|
|
4220
|
+
Name | Type | Description | Notes
|
|
4221
|
+
------------- | ------------- | ------------- | -------------
|
|
4222
|
+
**user_id** | **Integer**| |
|
|
4223
|
+
**mcp_server_uuid** | **String**| |
|
|
4224
|
+
**mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md)| MCP Server |
|
|
4225
|
+
|
|
4226
|
+
### Return type
|
|
4227
|
+
|
|
4228
|
+
[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
|
|
4229
|
+
|
|
4230
|
+
### Authorization
|
|
4231
|
+
|
|
4232
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4233
|
+
|
|
4234
|
+
### HTTP request headers
|
|
4235
|
+
|
|
4236
|
+
- **Content-Type**: application/json
|
|
4237
|
+
- **Accept**: application/json
|
|
4238
|
+
|
|
4239
|
+
|
|
4240
|
+
|
|
4184
4241
|
# **update_conversation_canned_message**
|
|
4185
4242
|
> ConversationCannedMessageResponse update_conversation_canned_message(conversation_canned_message_oid, canned_message)
|
|
4186
4243
|
|
|
@@ -142,7 +142,7 @@ module UltracartClient
|
|
|
142
142
|
# http body (model)
|
|
143
143
|
post_body = nil
|
|
144
144
|
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
145
|
-
data, status_code, headers = @api_client.call_api(:
|
|
145
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
146
146
|
:header_params => header_params,
|
|
147
147
|
:query_params => query_params,
|
|
148
148
|
:form_params => form_params,
|
|
@@ -4531,6 +4531,73 @@ module UltracartClient
|
|
|
4531
4531
|
end
|
|
4532
4532
|
return data, status_code, headers
|
|
4533
4533
|
end
|
|
4534
|
+
# Update an agent MCP server
|
|
4535
|
+
# Update an agent MCP server
|
|
4536
|
+
# @param user_id
|
|
4537
|
+
# @param mcp_server_uuid
|
|
4538
|
+
# @param mcp_server MCP Server
|
|
4539
|
+
# @param [Hash] opts the optional parameters
|
|
4540
|
+
# @return [ConversationMcpServerResponse]
|
|
4541
|
+
def update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server, opts = {})
|
|
4542
|
+
data, _status_code, _headers = update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server, opts)
|
|
4543
|
+
data
|
|
4544
|
+
end
|
|
4545
|
+
|
|
4546
|
+
# Update an agent MCP server
|
|
4547
|
+
# Update an agent MCP server
|
|
4548
|
+
# @param user_id
|
|
4549
|
+
# @param mcp_server_uuid
|
|
4550
|
+
# @param mcp_server MCP Server
|
|
4551
|
+
# @param [Hash] opts the optional parameters
|
|
4552
|
+
# @return [Array<(ConversationMcpServerResponse, Fixnum, Hash)>] ConversationMcpServerResponse data, response status code and response headers
|
|
4553
|
+
def update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server, opts = {})
|
|
4554
|
+
if @api_client.config.debugging
|
|
4555
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_agent_profile_mcp ...'
|
|
4556
|
+
end
|
|
4557
|
+
# verify the required parameter 'user_id' is set
|
|
4558
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
4559
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.update_agent_profile_mcp"
|
|
4560
|
+
end
|
|
4561
|
+
# verify the required parameter 'mcp_server_uuid' is set
|
|
4562
|
+
if @api_client.config.client_side_validation && mcp_server_uuid.nil?
|
|
4563
|
+
fail ArgumentError, "Missing the required parameter 'mcp_server_uuid' when calling ConversationApi.update_agent_profile_mcp"
|
|
4564
|
+
end
|
|
4565
|
+
# verify the required parameter 'mcp_server' is set
|
|
4566
|
+
if @api_client.config.client_side_validation && mcp_server.nil?
|
|
4567
|
+
fail ArgumentError, "Missing the required parameter 'mcp_server' when calling ConversationApi.update_agent_profile_mcp"
|
|
4568
|
+
end
|
|
4569
|
+
# resource path
|
|
4570
|
+
local_var_path = '/conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}'.sub('{' + 'user_id' + '}', user_id.to_s).sub('{' + 'mcp_server_uuid' + '}', mcp_server_uuid.to_s)
|
|
4571
|
+
|
|
4572
|
+
# query parameters
|
|
4573
|
+
query_params = {}
|
|
4574
|
+
|
|
4575
|
+
# header parameters
|
|
4576
|
+
header_params = {}
|
|
4577
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4578
|
+
# HTTP header 'Accept' (if needed)
|
|
4579
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4580
|
+
# HTTP header 'Content-Type'
|
|
4581
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
4582
|
+
|
|
4583
|
+
# form parameters
|
|
4584
|
+
form_params = {}
|
|
4585
|
+
|
|
4586
|
+
# http body (model)
|
|
4587
|
+
post_body = @api_client.object_to_http_body(mcp_server)
|
|
4588
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4589
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
4590
|
+
:header_params => header_params,
|
|
4591
|
+
:query_params => query_params,
|
|
4592
|
+
:form_params => form_params,
|
|
4593
|
+
:body => post_body,
|
|
4594
|
+
:auth_names => auth_names,
|
|
4595
|
+
:return_type => 'ConversationMcpServerResponse')
|
|
4596
|
+
if @api_client.config.debugging
|
|
4597
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_agent_profile_mcp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4598
|
+
end
|
|
4599
|
+
return data, status_code, headers
|
|
4600
|
+
end
|
|
4534
4601
|
# Update a canned message
|
|
4535
4602
|
# Update a canned message
|
|
4536
4603
|
# @param conversation_canned_message_oid
|