ultracart_api 4.0.96.rc → 4.0.98.rc

data/docs/ConversationApi.md

@@ -9,17 +9,25 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation |
 | [**get_conversation_canned_messages**](ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code |
 | [**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context |
+| [**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name |
+| [**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name |
 | [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages |
 | [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL |
 | [**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses |
 | [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest |
+| [**get_conversations_autocomplete**](ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field |
+| [**get_conversations_search**](ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations |
 | [**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 |
 | [**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 |
 | [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
 | [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
 | [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
 | [**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 |
 | [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue |
 
 
@@ -372,6 +380,142 @@ end
 - **Accept**: application/json
 
 
+## get_conversation_departments
+
+> <ConversationDepartmentsResponse> get_conversation_departments
+
+Retrieve a list of departments ordered by name
+
+Retrieve a list of departments ordered by name 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+begin
+  # Retrieve a list of departments ordered by name
+  result = api_instance.get_conversation_departments
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_departments: #{e}"
+end
+```
+
+#### Using the get_conversation_departments_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationDepartmentsResponse>, Integer, Hash)> get_conversation_departments_with_http_info
+
+```ruby
+begin
+  # Retrieve a list of departments ordered by name
+  data, status_code, headers = api_instance.get_conversation_departments_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationDepartmentsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_departments_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationDepartmentsResponse**](ConversationDepartmentsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_conversation_engagements
+
+> <ConversationEngagementsResponse> get_conversation_engagements
+
+Retrieve a list of engagements ordered by name
+
+Retrieve a list of engagements ordered by name 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+begin
+  # Retrieve a list of engagements ordered by name
+  result = api_instance.get_conversation_engagements
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_engagements: #{e}"
+end
+```
+
+#### Using the get_conversation_engagements_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationEngagementsResponse>, Integer, Hash)> get_conversation_engagements_with_http_info
+
+```ruby
+begin
+  # Retrieve a list of engagements ordered by name
+  data, status_code, headers = api_instance.get_conversation_engagements_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationEngagementsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_engagements_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationEngagementsResponse**](ConversationEngagementsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_conversation_messages
 
 > <ConversationMessagesResponse> get_conversation_messages(conversation_uuid, since, opts)
@@ -667,6 +811,148 @@ end
 - **Accept**: application/json
 
 
+## get_conversations_autocomplete
+
+> <ConversationAutocompleteResponse> get_conversations_autocomplete(autocomplete_request)
+
+Retrieve a list of matching terms for a search field
+
+Retrieve a list of matching terms for a search field 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+autocomplete_request = UltracartClient::ConversationAutocompleteRequest.new # ConversationAutocompleteRequest | Autocomplete Request
+
+begin
+  # Retrieve a list of matching terms for a search field
+  result = api_instance.get_conversations_autocomplete(autocomplete_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversations_autocomplete: #{e}"
+end
+```
+
+#### Using the get_conversations_autocomplete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationAutocompleteResponse>, Integer, Hash)> get_conversations_autocomplete_with_http_info(autocomplete_request)
+
+```ruby
+begin
+  # Retrieve a list of matching terms for a search field
+  data, status_code, headers = api_instance.get_conversations_autocomplete_with_http_info(autocomplete_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationAutocompleteResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversations_autocomplete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **autocomplete_request** | [**ConversationAutocompleteRequest**](ConversationAutocompleteRequest.md) | Autocomplete Request |  |
+
+### Return type
+
+[**ConversationAutocompleteResponse**](ConversationAutocompleteResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_conversations_search
+
+> <ConversationSearchResponse> get_conversations_search(search_request)
+
+Search conversations
+
+Search conversations 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+search_request = UltracartClient::ConversationSearchRequest.new # ConversationSearchRequest | Search Request
+
+begin
+  # Search conversations
+  result = api_instance.get_conversations_search(search_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversations_search: #{e}"
+end
+```
+
+#### Using the get_conversations_search_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationSearchResponse>, Integer, Hash)> get_conversations_search_with_http_info(search_request)
+
+```ruby
+begin
+  # Search conversations
+  data, status_code, headers = api_instance.get_conversations_search_with_http_info(search_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationSearchResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversations_search_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search_request** | [**ConversationSearchRequest**](ConversationSearchRequest.md) | Search Request |  |
+
+### Return type
+
+[**ConversationSearchResponse**](ConversationSearchResponse.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)
@@ -738,9 +1024,151 @@ end
 - **Accept**: application/json
 
 
+## insert_conversation_department
+
+> <ConversationDepartmentResponse> insert_conversation_department(department)
+
+Insert a department
+
+Insert a department 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
+
+begin
+  # Insert a department
+  result = api_instance.insert_conversation_department(department)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->insert_conversation_department: #{e}"
+end
+```
+
+#### Using the insert_conversation_department_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationDepartmentResponse>, Integer, Hash)> insert_conversation_department_with_http_info(department)
+
+```ruby
+begin
+  # Insert a department
+  data, status_code, headers = api_instance.insert_conversation_department_with_http_info(department)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationDepartmentResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->insert_conversation_department_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **department** | [**ConversationDepartment**](ConversationDepartment.md) | Department |  |
+
+### Return type
+
+[**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## insert_conversation_engagement
+
+> <ConversationEngagementResponse> insert_conversation_engagement(engagement)
+
+Insert a engagement
+
+Insert a engagement 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
+
+begin
+  # Insert a engagement
+  result = api_instance.insert_conversation_engagement(engagement)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->insert_conversation_engagement: #{e}"
+end
+```
+
+#### Using the insert_conversation_engagement_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationEngagementResponse>, Integer, Hash)> insert_conversation_engagement_with_http_info(engagement)
+
+```ruby
+begin
+  # Insert a engagement
+  data, status_code, headers = api_instance.insert_conversation_engagement_with_http_info(engagement)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationEngagementResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->insert_conversation_engagement_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **engagement** | [**ConversationEngagement**](ConversationEngagement.md) | Engagement |  |
+
+### Return type
+
+[**ConversationEngagementResponse**](ConversationEngagementResponse.md)
+
+### 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)
+> join_conversation(conversation_uuid, opts)
 
 Join a conversation
 
@@ -761,10 +1189,13 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
 
 api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
 conversation_uuid = 'conversation_uuid_example' # String | 
+opts = {
+  join_request: UltracartClient::ConversationJoinRequest.new # ConversationJoinRequest | Join request
+}
 
 begin
   # Join a conversation
-  api_instance.join_conversation(conversation_uuid)
+  api_instance.join_conversation(conversation_uuid, opts)
 rescue UltracartClient::ApiError => e
   puts "Error when calling ConversationApi->join_conversation: #{e}"
 end
@@ -774,12 +1205,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> join_conversation_with_http_info(conversation_uuid)
+> <Array(nil, Integer, Hash)> join_conversation_with_http_info(conversation_uuid, opts)
 
 ```ruby
 begin
   # Join a conversation
-  data, status_code, headers = api_instance.join_conversation_with_http_info(conversation_uuid)
+  data, status_code, headers = api_instance.join_conversation_with_http_info(conversation_uuid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -793,6 +1224,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **conversation_uuid** | **String** |  |  |
+| **join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md) | Join request | [optional] |
 
 ### Return type
 
@@ -804,7 +1236,7 @@ nil (empty response body)
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 
@@ -1163,6 +1595,152 @@ end
 - **Accept**: application/json
 
 
+## update_conversation_department
+
+> <ConversationDepartmentResponse> update_conversation_department(conversation_department_oid, department)
+
+Update a department
+
+Update a department 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+conversation_department_oid = 56 # Integer | 
+department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
+
+begin
+  # Update a department
+  result = api_instance.update_conversation_department(conversation_department_oid, department)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_conversation_department: #{e}"
+end
+```
+
+#### Using the update_conversation_department_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationDepartmentResponse>, Integer, Hash)> update_conversation_department_with_http_info(conversation_department_oid, department)
+
+```ruby
+begin
+  # Update a department
+  data, status_code, headers = api_instance.update_conversation_department_with_http_info(conversation_department_oid, department)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationDepartmentResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_conversation_department_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_department_oid** | **Integer** |  |  |
+| **department** | [**ConversationDepartment**](ConversationDepartment.md) | Department |  |
+
+### Return type
+
+[**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_conversation_engagement
+
+> <ConversationEngagementResponse> update_conversation_engagement(conversation_engagement_oid, engagement)
+
+Update a engagement
+
+Update a engagement 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+conversation_engagement_oid = 56 # Integer | 
+engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
+
+begin
+  # Update a engagement
+  result = api_instance.update_conversation_engagement(conversation_engagement_oid, engagement)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_conversation_engagement: #{e}"
+end
+```
+
+#### Using the update_conversation_engagement_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationEngagementResponse>, Integer, Hash)> update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement)
+
+```ruby
+begin
+  # Update a engagement
+  data, status_code, headers = api_instance.update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationEngagementResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_conversation_engagement_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_engagement_oid** | **Integer** |  |  |
+| **engagement** | [**ConversationEngagement**](ConversationEngagement.md) | Engagement |  |
+
+### Return type
+
+[**ConversationEngagementResponse**](ConversationEngagementResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_conversation_webchat_queue_status
 
 > update_conversation_webchat_queue_status(queue_name, status_request)

data/docs/ConversationAutocompleteRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::ConversationAutocompleteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** |  | [optional] |
+| **term** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAutocompleteRequest.new(
+  field: null,
+  term: null
+)
+```
+