ultracart_api 4.1.150 → 4.1.151

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dd10e0e13b853be44db9716b0141fab32c531e40f176c6e6e116107da27464e
-  data.tar.gz: 551f2e71eef3b0d331b0599f79113a70c50ce1e610135a6b4b1cb0ba34cc7431
+  metadata.gz: 264c6285dc9c3bb82c146898640ca02fc525273a9462e8337e50b33dc768ae76
+  data.tar.gz: 05ccae03d410d9581c6915ef9e5797dfe2396d5286ad813f81c8e8aeadafb9ca
 SHA512:
-  metadata.gz: 1a1fea1e8d56f3a4ce8e45a3bec035bb1044e5fef96f3b3afc8eef8723c07d48f0f498e7d2c27b3e0cdf992876e0dd7db75cd16625fb94780cb6f0d87930cec0
-  data.tar.gz: 18df8e1fdbf9bc225af078d8259641e2930491d5fbec6b3fcdf0b48a506ec17a35aa7ab20c99b57f7088e1097d790467058f032953b20b54915e1d90ca61c0ad
+  metadata.gz: 7fc804a4da9627b106475e373aa2f337a40a0d0dabd82d8aa9ac0bb33153a15c2b4c10b3555135201a31f44809f92fd974458152241b187bcee25076c726adf1
+  data.tar.gz: ecb3276f325660d99d01cec717abac3e18858e0ed40cafdbe416cdd632108c212fcb257d118d6e264e2db32a551703b70889eb4c7e718771612612b845b6216a

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.150
+- Package version: 4.1.151
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.150'
+gem 'ultracart_api', '4.1.151'
 ```
 
 install:
@@ -252,6 +252,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**insert_pbx_time_range**](docs/ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange
 *UltracartClient::ConversationApi* | [**insert_pbx_voicemail_mailbox**](docs/ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
 *UltracartClient::ConversationApi* | [**insert_user_pbx_audio**](docs/ConversationApi.md#insert_user_pbx_audio) | **POST** /conversation/pbx/audio/user | Insert user pbx audio
+*UltracartClient::ConversationApi* | [**join_agent_test_session**](docs/ConversationApi.md#join_agent_test_session) | **PUT** /conversation/agent/profiles/{user_id}/test_session/{conversation_uuid}/join | Join a test conversation as the simulated customer
 *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
 *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
 *UltracartClient::ConversationApi* | [**listened_pbx_agent_voicemail**](docs/ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
@@ -267,6 +268,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**search_pbx_available_phone_numbers**](docs/ConversationApi.md#search_pbx_available_phone_numbers) | **GET** /conversation/pbx/phone_number/search | Search for available phone numbers
 *UltracartClient::ConversationApi* | [**search_pbx_calls**](docs/ConversationApi.md#search_pbx_calls) | **POST** /conversation/pbx/call/search | Search pbx call records
 *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_agent_test_session**](docs/ConversationApi.md#start_agent_test_session) | **PUT** /conversation/agent/profiles/{user_id}/test_session | Start a test conversation with this AI agent
 *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
@@ -941,6 +943,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationAgentStatusRollupSearchResponse](docs/ConversationAgentStatusRollupSearchResponse.md)
  - [UltracartClient::ConversationAgentStatusSummaryResponse](docs/ConversationAgentStatusSummaryResponse.md)
  - [UltracartClient::ConversationAgentStatusTimelineResponse](docs/ConversationAgentStatusTimelineResponse.md)
+ - [UltracartClient::ConversationAgentTestSessionJoinRequest](docs/ConversationAgentTestSessionJoinRequest.md)
+ - [UltracartClient::ConversationAgentTestSessionRequest](docs/ConversationAgentTestSessionRequest.md)
+ - [UltracartClient::ConversationAgentTestSessionResponse](docs/ConversationAgentTestSessionResponse.md)
  - [UltracartClient::ConversationAutocompleteRequest](docs/ConversationAutocompleteRequest.md)
  - [UltracartClient::ConversationAutocompleteResponse](docs/ConversationAutocompleteResponse.md)
  - [UltracartClient::ConversationAutocompleteValue](docs/ConversationAutocompleteValue.md)
@@ -948,6 +953,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
  - [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
  - [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
+ - [UltracartClient::ConversationCustomerAuth](docs/ConversationCustomerAuth.md)
  - [UltracartClient::ConversationDeleteKnowledgeBaseDocumentResponse](docs/ConversationDeleteKnowledgeBaseDocumentResponse.md)
  - [UltracartClient::ConversationDepartment](docs/ConversationDepartment.md)
  - [UltracartClient::ConversationDepartmentMember](docs/ConversationDepartmentMember.md)
@@ -1928,6 +1934,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.151 | 09/04/2026 | conversations - added ai agent capabilities |
 | 4.1.150 | 09/04/2026 | conversations - add ai agent capabilities |
 | 4.1.149 | 09/04/2026 | conversations - added ai agent capabilities |
 | 4.1.148 | 09/04/2026 | conversations - added ai agent capabilities |

data/docs/ConversationAgentTestSessionJoinRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::ConversationAgentTestSessionJoinRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_webchat_queue_uuid** | **String** | Queue entry uuid returned when the test session was started | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentTestSessionJoinRequest.new(
+  conversation_webchat_queue_uuid: null
+)
+```
+

data/docs/ConversationAgentTestSessionRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::ConversationAgentTestSessionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_profile_oid** | **Integer** | Customer profile to converse as.  The cart is established as a soft login for this customer, so the agent sees their real order history. | [optional] |
+| **question** | **String** | Optional opening question, the same way a customer types one before joining the queue. | [optional] |
+| **queue_name** | **String** | Webchat queue to join.  The agent is selected explicitly, so this does not have to be a queue the agent is assigned to. | [optional] |
+| **storefront_host_name** | **String** | Host name of the storefront to test against, with no protocol prefix.  Determines which catalog the agent searches. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentTestSessionRequest.new(
+  customer_profile_oid: null,
+  question: null,
+  queue_name: null,
+  storefront_host_name: null
+)
+```
+

data/docs/ConversationAgentTestSessionResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::ConversationAgentTestSessionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cart_id** | **String** | Cart established for this session, soft logged in as the chosen customer profile.  Real, and anything the agent adds to it persists. | [optional] |
+| **conversation_webchat_queue_uuid** | **String** | Queue entry created for this session | [optional] |
+| **customer_auth** | [**ConversationCustomerAuth**](ConversationCustomerAuth.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **storefront_host_name** | **String** | Storefront the session is running against | [optional] |
+| **success** | **Boolean** |  | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentTestSessionResponse.new(
+  cart_id: null,
+  conversation_webchat_queue_uuid: null,
+  customer_auth: null,
+  error: null,
+  metadata: null,
+  storefront_host_name: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationApi.md

@@ -107,6 +107,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**insert_pbx_time_range**](ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange |
 | [**insert_pbx_voicemail_mailbox**](ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox |
 | [**insert_user_pbx_audio**](ConversationApi.md#insert_user_pbx_audio) | **POST** /conversation/pbx/audio/user | Insert user pbx audio |
+| [**join_agent_test_session**](ConversationApi.md#join_agent_test_session) | **PUT** /conversation/agent/profiles/{user_id}/test_session/{conversation_uuid}/join | Join a test conversation as the simulated customer |
 | [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
 | [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
 | [**listened_pbx_agent_voicemail**](ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail |
@@ -122,6 +123,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**search_pbx_available_phone_numbers**](ConversationApi.md#search_pbx_available_phone_numbers) | **GET** /conversation/pbx/phone_number/search | Search for available phone numbers |
 | [**search_pbx_calls**](ConversationApi.md#search_pbx_calls) | **POST** /conversation/pbx/call/search | Search pbx call records |
 | [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation |
+| [**start_agent_test_session**](ConversationApi.md#start_agent_test_session) | **PUT** /conversation/agent/profiles/{user_id}/test_session | Start a test conversation with this AI agent |
 | [**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 |
@@ -5632,6 +5634,61 @@ end
 - **Accept**: application/json
 
 
+## join_agent_test_session
+
+> join_agent_test_session(user_id, conversation_uuid, join_request)
+
+Join a test conversation as the simulated customer
+
+Joins the simulated customer to the conversation the agent opened for a test session.  This mirrors what the storefront webchat widget does after an agent picks up its queue entry, and it is what gives the conversation a customer participant.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the join_agent_test_session_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> join_agent_test_session_with_http_info(user_id, conversation_uuid, join_request)
+
+```ruby
+begin
+  # Join a test conversation as the simulated customer
+  data, status_code, headers = api_instance.join_agent_test_session_with_http_info(user_id, conversation_uuid, join_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->join_agent_test_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **Integer** |  |  |
+| **conversation_uuid** | **String** |  |  |
+| **join_request** | [**ConversationAgentTestSessionJoinRequest**](ConversationAgentTestSessionJoinRequest.md) | Test session join request |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## join_conversation
 
 > join_conversation(conversation_uuid, opts)
@@ -6449,6 +6506,60 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## start_agent_test_session
+
+> <ConversationAgentTestSessionResponse> start_agent_test_session(user_id, test_session_request)
+
+Start a test conversation with this AI agent
+
+Opens a webchat conversation against this specific AI agent as if the given customer had started it from the storefront, so the agent can be tried out before it is put in front of anyone.  The session runs against live data: the cart is real, the customer is real, and anything the agent does during the conversation actually happens.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the start_agent_test_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationAgentTestSessionResponse>, Integer, Hash)> start_agent_test_session_with_http_info(user_id, test_session_request)
+
+```ruby
+begin
+  # Start a test conversation with this AI agent
+  data, status_code, headers = api_instance.start_agent_test_session_with_http_info(user_id, test_session_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationAgentTestSessionResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->start_agent_test_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **Integer** |  |  |
+| **test_session_request** | [**ConversationAgentTestSessionRequest**](ConversationAgentTestSessionRequest.md) | Test session request |  |
+
+### Return type
+
+[**ConversationAgentTestSessionResponse**](ConversationAgentTestSessionResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## start_conversation
 
 > <ConversationStartResponse> start_conversation(start_request)

data/docs/ConversationCustomerAuth.md

@@ -0,0 +1,30 @@
+# UltracartClient::ConversationCustomerAuth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_participant_arn** | **String** |  | [optional] |
+| **conversation_participant_name** | **String** |  | [optional] |
+| **join_dts_conversation_participant_arn** | **String** |  | [optional] |
+| **jwt** | **String** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **merchant_id_queue_name** | **String** |  | [optional] |
+| **websocket_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationCustomerAuth.new(
+  conversation_participant_arn: null,
+  conversation_participant_name: null,
+  join_dts_conversation_participant_arn: null,
+  jwt: null,
+  merchant_id: null,
+  merchant_id_queue_name: null,
+  websocket_url: null
+)
+```
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -6646,6 +6646,87 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Join a test conversation as the simulated customer
+    # Joins the simulated customer to the conversation the agent opened for a test session.  This mirrors what the storefront webchat widget does after an agent picks up its queue entry, and it is what gives the conversation a customer participant.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this. 
+    # @param user_id [Integer] 
+    # @param conversation_uuid [String] 
+    # @param join_request [ConversationAgentTestSessionJoinRequest] Test session join request
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def join_agent_test_session(user_id, conversation_uuid, join_request, opts = {})
+      join_agent_test_session_with_http_info(user_id, conversation_uuid, join_request, opts)
+      nil
+    end
+
+    # Join a test conversation as the simulated customer
+    # Joins the simulated customer to the conversation the agent opened for a test session.  This mirrors what the storefront webchat widget does after an agent picks up its queue entry, and it is what gives the conversation a customer participant.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this. 
+    # @param user_id [Integer] 
+    # @param conversation_uuid [String] 
+    # @param join_request [ConversationAgentTestSessionJoinRequest] Test session join request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def join_agent_test_session_with_http_info(user_id, conversation_uuid, join_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.join_agent_test_session ...'
+      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.join_agent_test_session"
+      end
+      # verify the required parameter 'conversation_uuid' is set
+      if @api_client.config.client_side_validation && conversation_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.join_agent_test_session"
+      end
+      # verify the required parameter 'join_request' is set
+      if @api_client.config.client_side_validation && join_request.nil?
+        fail ArgumentError, "Missing the required parameter 'join_request' when calling ConversationApi.join_agent_test_session"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles/{user_id}/test_session/{conversation_uuid}/join'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'conversation_uuid' + '}', CGI.escape(conversation_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(join_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.join_agent_test_session",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#join_agent_test_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Join a conversation
     # Join a conversation 
     # @param conversation_uuid [String] 
@@ -7689,6 +7770,81 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Start a test conversation with this AI agent
+    # Opens a webchat conversation against this specific AI agent as if the given customer had started it from the storefront, so the agent can be tried out before it is put in front of anyone.  The session runs against live data: the cart is real, the customer is real, and anything the agent does during the conversation actually happens.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this. 
+    # @param user_id [Integer] 
+    # @param test_session_request [ConversationAgentTestSessionRequest] Test session request
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationAgentTestSessionResponse]
+    def start_agent_test_session(user_id, test_session_request, opts = {})
+      data, _status_code, _headers = start_agent_test_session_with_http_info(user_id, test_session_request, opts)
+      data
+    end
+
+    # Start a test conversation with this AI agent
+    # Opens a webchat conversation against this specific AI agent as if the given customer had started it from the storefront, so the agent can be tried out before it is put in front of anyone.  The session runs against live data: the cart is real, the customer is real, and anything the agent does during the conversation actually happens.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this. 
+    # @param user_id [Integer] 
+    # @param test_session_request [ConversationAgentTestSessionRequest] Test session request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationAgentTestSessionResponse, Integer, Hash)>] ConversationAgentTestSessionResponse data, response status code and response headers
+    def start_agent_test_session_with_http_info(user_id, test_session_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.start_agent_test_session ...'
+      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.start_agent_test_session"
+      end
+      # verify the required parameter 'test_session_request' is set
+      if @api_client.config.client_side_validation && test_session_request.nil?
+        fail ArgumentError, "Missing the required parameter 'test_session_request' when calling ConversationApi.start_agent_test_session"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles/{user_id}/test_session'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(test_session_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationAgentTestSessionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.start_agent_test_session",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#start_agent_test_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Start a conversation
     # Start a new conversation 
     # @param start_request [ConversationStartRequest] Start request