ultracart_api 3.10.79 → 3.10.81

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f1b06246610265119d5f2c024c15f2ed7990269ba30d41c48a21b1501b3e712
-  data.tar.gz: 6982b8c9c64cf0229e7bf41b4601e3901f32af9cb8c87d8ff851807d32a55913
+  metadata.gz: 06c357e935ee1e8ba7df4774cf3bb451d1bb312f791d215d785a0379ad5181ba
+  data.tar.gz: 6b6c63d5b5c705abe450b15d07ee25259091468ae3b6373437709868b4a3fa4f
 SHA512:
-  metadata.gz: f54d96485071188f8169164e15419e2d46b615ef074c0c5247439c8877b2fe70ac651ec83d9e8f467bf3069a03b5247b93f93a04f3c68501b841e438042611c6
-  data.tar.gz: c8520b58a27a96d3e2a8b747492e43ebaecbcfe3f89f2707680f3428535999632f8e4bf0e0da0ba3e976551721ee1225a4acfe06cc286ae5a9f04ea23e2808a6
+  metadata.gz: 3c0ab1e20aa5aca0e2260d57c366ed62d7b37ac49126a6dd592a589f771ccaa03f2a65a8669612e48a850af6b1c69f5859edaf1cacfe4f157bd7ea67eb4e7fc1
+  data.tar.gz: 287a398c2da5e9a3f8312cdbb9639ceb164addbee4a494beac618c301b3e7306fb451441681792a964d3d52a8326221ac13fad546f94281c128c4b197566ec93

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.10.79
+- Package version: 3.10.81
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.79.gem
+gem install ./ultracart_api-3.10.81.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.79.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.81.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.10.79'
+    gem 'ultracart_api', '~> 3.10.81'
 
 ### Install from Git
 
@@ -130,17 +130,25 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
 *UltracartClient::ConversationApi* | [**get_conversation_canned_messages**](docs/ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
 *UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
+*UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
+*UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
 *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
 *UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
 *UltracartClient::ConversationApi* | [**get_conversation_webchat_queue_statuses**](docs/ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
 *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
+*UltracartClient::ConversationApi* | [**get_conversations_autocomplete**](docs/ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field
+*UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
 *UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
+*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
+*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
 *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* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 *UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 *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
 *UltracartClient::ConversationApi* | [**update_conversation_webchat_queue_status**](docs/ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
 *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
 *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
@@ -589,10 +597,20 @@ Class | Method | HTTP request | Description
  - [UltracartClient::Conversation](docs/Conversation.md)
  - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
+ - [UltracartClient::ConversationAutocompleteRequest](docs/ConversationAutocompleteRequest.md)
+ - [UltracartClient::ConversationAutocompleteResponse](docs/ConversationAutocompleteResponse.md)
  - [UltracartClient::ConversationCannedMessage](docs/ConversationCannedMessage.md)
  - [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
  - [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
  - [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
+ - [UltracartClient::ConversationDepartment](docs/ConversationDepartment.md)
+ - [UltracartClient::ConversationDepartmentResponse](docs/ConversationDepartmentResponse.md)
+ - [UltracartClient::ConversationDepartmentSettings](docs/ConversationDepartmentSettings.md)
+ - [UltracartClient::ConversationDepartmentsResponse](docs/ConversationDepartmentsResponse.md)
+ - [UltracartClient::ConversationEngagement](docs/ConversationEngagement.md)
+ - [UltracartClient::ConversationEngagementEquation](docs/ConversationEngagementEquation.md)
+ - [UltracartClient::ConversationEngagementResponse](docs/ConversationEngagementResponse.md)
+ - [UltracartClient::ConversationEngagementsResponse](docs/ConversationEngagementsResponse.md)
  - [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
  - [UltracartClient::ConversationEventAddItem](docs/ConversationEventAddItem.md)
  - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
@@ -600,6 +618,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
  - [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
  - [UltracartClient::ConversationEventWebchatContext](docs/ConversationEventWebchatContext.md)
+ - [UltracartClient::ConversationJoinRequest](docs/ConversationJoinRequest.md)
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
  - [UltracartClient::ConversationMessageTranslation](docs/ConversationMessageTranslation.md)
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
@@ -608,6 +627,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
  - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
  - [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
+ - [UltracartClient::ConversationSearchRequest](docs/ConversationSearchRequest.md)
+ - [UltracartClient::ConversationSearchResponse](docs/ConversationSearchResponse.md)
  - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
  - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
@@ -1236,6 +1257,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.81 | 12/15/2022 | conversation searching |
+| 3.10.80 | 12/13/2022 | conversations - add email and sms_phone to participant object |
 | 3.10.79 | 12/09/2022 | conversations - message translation |
 | 3.10.78 | 12/08/2022 | conversation canned messages |
 | 3.10.77 | 12/08/2022 | communications - expose the rebuild percentage |

data/docs/ConversationApi.md

@@ -9,17 +9,25 @@ Method | HTTP request | Description
 [**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
 
 
@@ -261,6 +269,96 @@ Name | Type | Description  | Notes
 
 
 
+# **get_conversation_departments**
+> ConversationDepartmentsResponse get_conversation_departments
+
+Retrieve a list of departments ordered by name
+
+Retrieve a list of departments ordered by name 
+
+### 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)
+
+
+
+begin
+  #Retrieve a list of departments ordered by name
+  result = api_instance.get_conversation_departments
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_conversation_departments: #{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**: application/json
+ - **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 
+
+### 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)
+
+
+
+begin
+  #Retrieve a list of engagements ordered by name
+  result = api_instance.get_conversation_engagements
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_conversation_engagements: #{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**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_conversation_messages**
 > ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
 
@@ -470,6 +568,106 @@ Name | Type | Description  | Notes
 
 
 
+# **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 
+
+### 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)
+
+
+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 "Exception when calling ConversationApi->get_conversations_autocomplete: #{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 
+
+### 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)
+
+
+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 "Exception when calling ConversationApi->get_conversations_search: #{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)
 
@@ -520,8 +718,108 @@ Name | Type | Description  | Notes
 
 
 
+# **insert_conversation_department**
+> ConversationDepartmentResponse insert_conversation_department(department)
+
+Insert a department
+
+Insert a department 
+
+### 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)
+
+
+department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
+
+
+begin
+  #Insert a department
+  result = api_instance.insert_conversation_department(department)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->insert_conversation_department: #{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 
+
+### 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)
+
+
+engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
+
+
+begin
+  #Insert a engagement
+  result = api_instance.insert_conversation_engagement(engagement)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->insert_conversation_engagement: #{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
 
@@ -539,10 +837,13 @@ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, fa
 
 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 "Exception when calling ConversationApi->join_conversation: #{e}"
 end
@@ -553,6 +854,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **conversation_uuid** | **String**|  | 
+ **join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md)| Join request | [optional] 
 
 ### Return type
 
@@ -820,6 +1122,112 @@ Name | Type | Description  | Notes
 
 
 
+# **update_conversation_department**
+> ConversationDepartmentResponse update_conversation_department(conversation_department_oid, department)
+
+Update a department
+
+Update a department 
+
+### 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)
+
+
+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 "Exception when calling ConversationApi->update_conversation_department: #{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 
+
+### 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)
+
+
+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 "Exception when calling ConversationApi->update_conversation_engagement: #{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,9 @@
+# UltracartClient::ConversationAutocompleteRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **String** |  | [optional] 
+**term** | **String** |  | [optional] 
+
+

data/docs/ConversationAutocompleteResponse.md

@@ -0,0 +1,14 @@
+# UltracartClient::ConversationAutocompleteResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**field** | **String** |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**results** | **Array<String>** |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**term** | **String** |  | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ConversationCannedMessage.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **canned_message** | **String** |  | [optional] 
 **conversation_canned_message_oid** | **Integer** |  | [optional] 
-**conversation_department_oids** | **Array<String>** |  | [optional] 
+**conversation_department_oids** | **Array<Integer>** |  | [optional] 
 **short_code** | **String** |  | [optional] 
 
 

data/docs/ConversationDepartment.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationDepartment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_department_oid** | **Integer** |  | [optional] 
+**delete_me** | **BOOLEAN** |  | [optional] 
+**department_name** | **String** |  | [optional] 
+**merchant_id** | **String** |  | [optional] 
+**settings** | [**ConversationDepartmentSettings**](ConversationDepartmentSettings.md) |  | [optional] 
+
+

data/docs/ConversationDepartmentResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationDepartmentResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_department** | [**ConversationDepartment**](ConversationDepartment.md) |  | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ConversationDepartmentSettings.md

@@ -0,0 +1,7 @@
+# UltracartClient::ConversationDepartmentSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/ConversationDepartmentsResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationDepartmentsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_departments** | [**Array<ConversationDepartment>**](ConversationDepartment.md) |  | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+