ultracart_api 3.11.31 → 3.11.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64f8c1d7d8aaee41012e2b5eb7f58b7b3bd112c8c519bccd2446bf82979bc7c1
-  data.tar.gz: 418be57ad7d637ae9cbe541875cf4a14221b93026ae20d65adf519d5273219a6
+  metadata.gz: d508630490dcc323c85795f81f82eb287507dc1fd2f0364b23265aae228d9f34
+  data.tar.gz: 278463342c54274fdc77271d5cea1f56dfa628b55102bdbfcec328da07ea0547
 SHA512:
-  metadata.gz: a13f629c10f32898918431ff7e95c8804c5b02956a99bc26c5cc73995814446f16ebac8b5913964ad6b453f0977ff89ed420fdcb00e370feb3e808c9ade54de0
-  data.tar.gz: f1b308bfb8afc2382b371ddb6556d69ba927701a1750b68b7adcb82839218f76c8cb262da35081f676e807b7ce79445ea0ece823649f7d45eea1dd34c720d676
+  metadata.gz: 0ab7d5fd8f7846ff9c6f6c097dfd849690fa15af0d4a2836a8a3704ce4f43f1d3d2dd1c0e6a25e3fc99b5ba54715da8885ab71b96aa976c2a3a0131871ac841e
+  data.tar.gz: 36089124805452a530233b7253e4e7ed0fe4354959fa12f15b3f1c4265594f14fc9e0f9b64a055edc1a51941181ec0b6818175ddeac1c377126d311d334e7989

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.31
+- Package version: 3.11.33
 - 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.31.gem
+gem install ./ultracart_api-3.11.33.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.31.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.33.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.31'
+    gem 'ultracart_api', '~> 3.11.33'
 
 ### Install from Git
 
@@ -134,7 +134,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
 *UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
 *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
-*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
+*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
 *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
 *UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
 *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
 *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
@@ -1600,6 +1601,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.33 | 11/26/2025 | conversation - AI agent profile fields |
+| 3.11.32 | 11/20/2025 | conversion api bug fix on incorrect signature |
 | 3.11.31 | 11/20/2025 | conversation - AI agent mcp server tools function |
 | 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 |

data/docs/ConversationAgentProfile.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **ai_chat_instructions** | **String** | Additional instructions for this AI when handle web chats | [optional] 
 **ai_persona** | **String** | Persona of this AI agent | [optional] 
 **ai_sms_instructions** | **String** | Additional instructions for this AI when handle SMS messages | [optional] 
+**ai_ticket_instructions** | **String** | Additional instructions for this AI when handling ticket draft replies | [optional] 
 **chat_limit** | **Integer** | The number of engagement chats that can be pushed on them at any given time. | [optional] 
 **default_language_iso_code** | **String** | The default language the agent is chatting in | [optional] 
 **default_status** | **String** | Default status when the agent loads conversations app. | [optional] 
@@ -15,5 +16,7 @@ Name | Type | Description | Notes
 **profile_image_upload_key** | **String** | An upload key used to update the profile image. | [optional] 
 **profile_image_url** | **String** | Their current profile image URL | [optional] 
 **user_id** | **Integer** | User ID associated with the agent.  Populated by getAgentProfiles call only. | [optional] 
+**zohodesk_classifications** | **Array<String>** | Restrict this agent to drafting replies only to tickets with these classifications | [optional] 
+**zohodesk_departments** | **Array<String>** | Restrict this agent to drafting replies only to these department ids | [optional] 
 
 

data/docs/ConversationApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**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
-[**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
+[**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
 [**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
 [**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
 [**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
@@ -87,6 +87,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
@@ -4181,6 +4182,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/lib/ultracart_api/api/conversation_api.rb

@@ -142,7 +142,7 @@ module UltracartClient
       # http body (model)
       post_body = nil
       auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -4531,6 +4531,73 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update an agent MCP server
+    # Update an agent MCP server 
+    # @param user_id 
+    # @param mcp_server_uuid 
+    # @param mcp_server MCP Server
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationMcpServerResponse]
+    def update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server, opts = {})
+      data, _status_code, _headers = update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server, opts)
+      data
+    end
+
+    # Update an agent MCP server
+    # Update an agent MCP server 
+    # @param user_id 
+    # @param mcp_server_uuid 
+    # @param mcp_server MCP Server
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationMcpServerResponse, Fixnum, Hash)>] ConversationMcpServerResponse data, response status code and response headers
+    def update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.update_agent_profile_mcp ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.update_agent_profile_mcp"
+      end
+      # verify the required parameter 'mcp_server_uuid' is set
+      if @api_client.config.client_side_validation && mcp_server_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'mcp_server_uuid' when calling ConversationApi.update_agent_profile_mcp"
+      end
+      # verify the required parameter 'mcp_server' is set
+      if @api_client.config.client_side_validation && mcp_server.nil?
+        fail ArgumentError, "Missing the required parameter 'mcp_server' when calling ConversationApi.update_agent_profile_mcp"
+      end
+      # resource path
+      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)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(mcp_server)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ConversationMcpServerResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#update_agent_profile_mcp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a canned message
     # Update a canned message 
     # @param conversation_canned_message_oid 

data/lib/ultracart_api/models/conversation_agent_profile.rb

@@ -26,6 +26,9 @@ module UltracartClient
     # Additional instructions for this AI when handle SMS messages
     attr_accessor :ai_sms_instructions
 
+    # Additional instructions for this AI when handling ticket draft replies
+    attr_accessor :ai_ticket_instructions
+
     # The number of engagement chats that can be pushed on them at any given time.
     attr_accessor :chat_limit
 
@@ -50,6 +53,12 @@ module UltracartClient
     # User ID associated with the agent.  Populated by getAgentProfiles call only.
     attr_accessor :user_id
 
+    # Restrict this agent to drafting replies only to tickets with these classifications
+    attr_accessor :zohodesk_classifications
+
+    # Restrict this agent to drafting replies only to these department ids
+    attr_accessor :zohodesk_departments
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -79,6 +88,7 @@ module UltracartClient
         :'ai_chat_instructions' => :'ai_chat_instructions',
         :'ai_persona' => :'ai_persona',
         :'ai_sms_instructions' => :'ai_sms_instructions',
+        :'ai_ticket_instructions' => :'ai_ticket_instructions',
         :'chat_limit' => :'chat_limit',
         :'default_language_iso_code' => :'default_language_iso_code',
         :'default_status' => :'default_status',
@@ -86,7 +96,9 @@ module UltracartClient
         :'name' => :'name',
         :'profile_image_upload_key' => :'profile_image_upload_key',
         :'profile_image_url' => :'profile_image_url',
-        :'user_id' => :'user_id'
+        :'user_id' => :'user_id',
+        :'zohodesk_classifications' => :'zohodesk_classifications',
+        :'zohodesk_departments' => :'zohodesk_departments'
       }
     end
 
@@ -97,6 +109,7 @@ module UltracartClient
         :'ai_chat_instructions' => :'String',
         :'ai_persona' => :'String',
         :'ai_sms_instructions' => :'String',
+        :'ai_ticket_instructions' => :'String',
         :'chat_limit' => :'Integer',
         :'default_language_iso_code' => :'String',
         :'default_status' => :'String',
@@ -104,7 +117,9 @@ module UltracartClient
         :'name' => :'String',
         :'profile_image_upload_key' => :'String',
         :'profile_image_url' => :'String',
-        :'user_id' => :'Integer'
+        :'user_id' => :'Integer',
+        :'zohodesk_classifications' => :'Array<String>',
+        :'zohodesk_departments' => :'Array<String>'
       }
     end
 
@@ -132,6 +147,10 @@ module UltracartClient
         self.ai_sms_instructions = attributes[:'ai_sms_instructions']
       end
 
+      if attributes.has_key?(:'ai_ticket_instructions')
+        self.ai_ticket_instructions = attributes[:'ai_ticket_instructions']
+      end
+
       if attributes.has_key?(:'chat_limit')
         self.chat_limit = attributes[:'chat_limit']
       end
@@ -163,6 +182,18 @@ module UltracartClient
       if attributes.has_key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
+
+      if attributes.has_key?(:'zohodesk_classifications')
+        if (value = attributes[:'zohodesk_classifications']).is_a?(Array)
+          self.zohodesk_classifications = value
+        end
+      end
+
+      if attributes.has_key?(:'zohodesk_departments')
+        if (value = attributes[:'zohodesk_departments']).is_a?(Array)
+          self.zohodesk_departments = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -199,6 +230,7 @@ module UltracartClient
           ai_chat_instructions == o.ai_chat_instructions &&
           ai_persona == o.ai_persona &&
           ai_sms_instructions == o.ai_sms_instructions &&
+          ai_ticket_instructions == o.ai_ticket_instructions &&
           chat_limit == o.chat_limit &&
           default_language_iso_code == o.default_language_iso_code &&
           default_status == o.default_status &&
@@ -206,7 +238,9 @@ module UltracartClient
           name == o.name &&
           profile_image_upload_key == o.profile_image_upload_key &&
           profile_image_url == o.profile_image_url &&
-          user_id == o.user_id
+          user_id == o.user_id &&
+          zohodesk_classifications == o.zohodesk_classifications &&
+          zohodesk_departments == o.zohodesk_departments
     end
 
     # @see the `==` method
@@ -218,7 +252,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ai, ai_chat_instructions, ai_persona, ai_sms_instructions, chat_limit, default_language_iso_code, default_status, display_name, name, profile_image_upload_key, profile_image_url, user_id].hash
+      [ai, ai_chat_instructions, ai_persona, ai_sms_instructions, ai_ticket_instructions, chat_limit, default_language_iso_code, default_status, display_name, name, profile_image_upload_key, profile_image_url, user_id, zohodesk_classifications, zohodesk_departments].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.11.31'
+  VERSION = '3.11.33'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.31
+  version: 3.11.33
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-20 00:00:00.000000000 Z
+date: 2025-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus