ultracart_api 4.1.31 → 4.1.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 +5 -3
- data/docs/ConversationApi.md +57 -1
- data/lib/ultracart_api/api/conversation_api.rb +82 -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: d5dd2120acc8bd531fa99107eab944d390ae6f6f19bada818cc09931433468df
|
|
4
|
+
data.tar.gz: 85d07c8f1a3c389c125b3daaafc100e83c7b7ba5157089953eb00cbc6ab59ec7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5caf8bae69eb3d5567ef463af247f386af9f31f4abfd314fb1a97fcd1cb730167d5d09de779ac10f8729e28a25ace42600f2c76281eca077a8afec2c66f838e1
|
|
7
|
+
data.tar.gz: d4dabc6c138700d44d8b34d414896bed7933dac7d2391f206b435879925c1365227fdb2aa944bca9b1c3febfe9d351dad3745d3b420d13ef907635eb6814cdc4
|
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.32
|
|
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.32'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -130,7 +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) | **
|
|
133
|
+
*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
|
|
134
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
|
|
135
135
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
|
136
136
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
|
@@ -212,6 +212,7 @@ Class | Method | HTTP request | Description
|
|
|
212
212
|
*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
|
|
213
213
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
214
214
|
*UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
|
|
215
|
+
*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
|
|
215
216
|
*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
|
|
216
217
|
*UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
|
|
217
218
|
*UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
|
|
@@ -1598,6 +1599,7 @@ Not every change is committed to every SDK.
|
|
|
1598
1599
|
|
|
1599
1600
|
| Version | Date | Comments |
|
|
1600
1601
|
| --: | :-: | --- |
|
|
1602
|
+
| 4.1.32 | 11/20/2025 | conversion api bug fix on incorrect signature |
|
|
1601
1603
|
| 4.1.31 | 11/20/2025 | conversation - AI agent mcp server tools function |
|
|
1602
1604
|
| 4.1.30 | 11/19/2025 | conversation - AI agent MCP server configuration methods |
|
|
1603
1605
|
| 4.1.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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
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 |
|
|
@@ -4546,6 +4547,61 @@ end
|
|
|
4546
4547
|
- **Accept**: application/json
|
|
4547
4548
|
|
|
4548
4549
|
|
|
4550
|
+
## update_agent_profile_mcp
|
|
4551
|
+
|
|
4552
|
+
> <ConversationMcpServerResponse> update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server)
|
|
4553
|
+
|
|
4554
|
+
Update an agent MCP server
|
|
4555
|
+
|
|
4556
|
+
Update an agent MCP server
|
|
4557
|
+
|
|
4558
|
+
|
|
4559
|
+
### Examples
|
|
4560
|
+
|
|
4561
|
+
|
|
4562
|
+
(No example for this operation).
|
|
4563
|
+
|
|
4564
|
+
|
|
4565
|
+
#### Using the update_agent_profile_mcp_with_http_info variant
|
|
4566
|
+
|
|
4567
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4568
|
+
|
|
4569
|
+
> <Array(<ConversationMcpServerResponse>, Integer, Hash)> update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server)
|
|
4570
|
+
|
|
4571
|
+
```ruby
|
|
4572
|
+
begin
|
|
4573
|
+
# Update an agent MCP server
|
|
4574
|
+
data, status_code, headers = api_instance.update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server)
|
|
4575
|
+
p status_code # => 2xx
|
|
4576
|
+
p headers # => { ... }
|
|
4577
|
+
p data # => <ConversationMcpServerResponse>
|
|
4578
|
+
rescue UltracartClient::ApiError => e
|
|
4579
|
+
puts "Error when calling ConversationApi->update_agent_profile_mcp_with_http_info: #{e}"
|
|
4580
|
+
end
|
|
4581
|
+
```
|
|
4582
|
+
|
|
4583
|
+
### Parameters
|
|
4584
|
+
|
|
4585
|
+
| Name | Type | Description | Notes |
|
|
4586
|
+
| ---- | ---- | ----------- | ----- |
|
|
4587
|
+
| **user_id** | **Integer** | | |
|
|
4588
|
+
| **mcp_server_uuid** | **String** | | |
|
|
4589
|
+
| **mcp_server** | [**ConversationMcpServer**](ConversationMcpServer.md) | MCP Server | |
|
|
4590
|
+
|
|
4591
|
+
### Return type
|
|
4592
|
+
|
|
4593
|
+
[**ConversationMcpServerResponse**](ConversationMcpServerResponse.md)
|
|
4594
|
+
|
|
4595
|
+
### Authorization
|
|
4596
|
+
|
|
4597
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4598
|
+
|
|
4599
|
+
### HTTP request headers
|
|
4600
|
+
|
|
4601
|
+
- **Content-Type**: application/json
|
|
4602
|
+
- **Accept**: application/json
|
|
4603
|
+
|
|
4604
|
+
|
|
4549
4605
|
## update_conversation_canned_message
|
|
4550
4606
|
|
|
4551
4607
|
> <ConversationCannedMessageResponse> update_conversation_canned_message(conversation_canned_message_oid, canned_message)
|
|
@@ -165,7 +165,7 @@ module UltracartClient
|
|
|
165
165
|
:return_type => return_type
|
|
166
166
|
)
|
|
167
167
|
|
|
168
|
-
data, status_code, headers = @api_client.call_api(:
|
|
168
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
169
169
|
if @api_client.config.debugging
|
|
170
170
|
@api_client.config.logger.debug "API called: ConversationApi#delete_agent_profile_mcp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
171
171
|
end
|
|
@@ -5382,6 +5382,87 @@ module UltracartClient
|
|
|
5382
5382
|
return data, status_code, headers
|
|
5383
5383
|
end
|
|
5384
5384
|
|
|
5385
|
+
# Update an agent MCP server
|
|
5386
|
+
# Update an agent MCP server
|
|
5387
|
+
# @param user_id [Integer]
|
|
5388
|
+
# @param mcp_server_uuid [String]
|
|
5389
|
+
# @param mcp_server [ConversationMcpServer] MCP Server
|
|
5390
|
+
# @param [Hash] opts the optional parameters
|
|
5391
|
+
# @return [ConversationMcpServerResponse]
|
|
5392
|
+
def update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server, opts = {})
|
|
5393
|
+
data, _status_code, _headers = update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server, opts)
|
|
5394
|
+
data
|
|
5395
|
+
end
|
|
5396
|
+
|
|
5397
|
+
# Update an agent MCP server
|
|
5398
|
+
# Update an agent MCP server
|
|
5399
|
+
# @param user_id [Integer]
|
|
5400
|
+
# @param mcp_server_uuid [String]
|
|
5401
|
+
# @param mcp_server [ConversationMcpServer] MCP Server
|
|
5402
|
+
# @param [Hash] opts the optional parameters
|
|
5403
|
+
# @return [Array<(ConversationMcpServerResponse, Integer, Hash)>] ConversationMcpServerResponse data, response status code and response headers
|
|
5404
|
+
def update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server, opts = {})
|
|
5405
|
+
if @api_client.config.debugging
|
|
5406
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_agent_profile_mcp ...'
|
|
5407
|
+
end
|
|
5408
|
+
# verify the required parameter 'user_id' is set
|
|
5409
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
5410
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.update_agent_profile_mcp"
|
|
5411
|
+
end
|
|
5412
|
+
# verify the required parameter 'mcp_server_uuid' is set
|
|
5413
|
+
if @api_client.config.client_side_validation && mcp_server_uuid.nil?
|
|
5414
|
+
fail ArgumentError, "Missing the required parameter 'mcp_server_uuid' when calling ConversationApi.update_agent_profile_mcp"
|
|
5415
|
+
end
|
|
5416
|
+
# verify the required parameter 'mcp_server' is set
|
|
5417
|
+
if @api_client.config.client_side_validation && mcp_server.nil?
|
|
5418
|
+
fail ArgumentError, "Missing the required parameter 'mcp_server' when calling ConversationApi.update_agent_profile_mcp"
|
|
5419
|
+
end
|
|
5420
|
+
# resource path
|
|
5421
|
+
local_var_path = '/conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'mcp_server_uuid' + '}', CGI.escape(mcp_server_uuid.to_s))
|
|
5422
|
+
|
|
5423
|
+
# query parameters
|
|
5424
|
+
query_params = opts[:query_params] || {}
|
|
5425
|
+
|
|
5426
|
+
# header parameters
|
|
5427
|
+
header_params = opts[:header_params] || {}
|
|
5428
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5429
|
+
# HTTP header 'Accept' (if needed)
|
|
5430
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5431
|
+
# HTTP header 'Content-Type'
|
|
5432
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
5433
|
+
if !content_type.nil?
|
|
5434
|
+
header_params['Content-Type'] = content_type
|
|
5435
|
+
end
|
|
5436
|
+
|
|
5437
|
+
# form parameters
|
|
5438
|
+
form_params = opts[:form_params] || {}
|
|
5439
|
+
|
|
5440
|
+
# http body (model)
|
|
5441
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(mcp_server)
|
|
5442
|
+
|
|
5443
|
+
# return_type
|
|
5444
|
+
return_type = opts[:debug_return_type] || 'ConversationMcpServerResponse'
|
|
5445
|
+
|
|
5446
|
+
# auth_names
|
|
5447
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5448
|
+
|
|
5449
|
+
new_options = opts.merge(
|
|
5450
|
+
:operation => :"ConversationApi.update_agent_profile_mcp",
|
|
5451
|
+
:header_params => header_params,
|
|
5452
|
+
:query_params => query_params,
|
|
5453
|
+
:form_params => form_params,
|
|
5454
|
+
:body => post_body,
|
|
5455
|
+
:auth_names => auth_names,
|
|
5456
|
+
:return_type => return_type
|
|
5457
|
+
)
|
|
5458
|
+
|
|
5459
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
5460
|
+
if @api_client.config.debugging
|
|
5461
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_agent_profile_mcp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5462
|
+
end
|
|
5463
|
+
return data, status_code, headers
|
|
5464
|
+
end
|
|
5465
|
+
|
|
5385
5466
|
# Update a canned message
|
|
5386
5467
|
# Update a canned message
|
|
5387
5468
|
# @param conversation_canned_message_oid [Integer]
|