ultracart_api 4.0.97.rc → 4.0.98.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294d5bdc4522349efee081d02d82ac9dc5893b8479931d7bd878de20ceba5f7e
-  data.tar.gz: 133d2c89438760ba5852cf886d14c9933d9fad98802f3dfb51fa225b5be5b009
+  metadata.gz: 8ee5f9abeb411470c29cb95f24580158cd0b9f891b0a297d7ce27ad4a752e652
+  data.tar.gz: b489c4b7819f86834f4290065706a4679b6467d843f98c8eb62a57267f11fc82
 SHA512:
-  metadata.gz: c118588dbacdfd72c426a85524752175e0d91fa1fcb8c1fb4219adae424d90776e48570ce16da5bb7775765bec36f1c5b97a47d84c0528f65eeaf43e87b12a58
-  data.tar.gz: 29bfe3f819d8bf5241ca4c7b3f0fb4a63c1091fee4939054db601b1a0bf9b1b666d1b518422641697313d98e6b6db1343a3a12ea1cfb03e714866b890130c7cf
+  metadata.gz: 74d4456113d178782aa23cea2c215480b4aa549e5b465828f1bbb9fcb5a9bdf7e15fab7c405e2a0b8fb278d868fa2c17f0c7363bcc0d53e1353cc439c49557ce
+  data.tar.gz: eb763b16714e71ca3d699c3dd6fd074d6b1953c2b68aa38edbf6f7331d60cbd45bdde27f7ebb158f5311cf2912bd025298a3723058c839f71b0dcfd0d40a6018

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.97.rc
+- Package version: 4.0.98.rc
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.97.rc.gem
+gem install ./ultracart_api-4.0.98.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.97.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.98.rc.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', '~> 4.0.97.rc'
+    gem 'ultracart_api', '~> 4.0.98.rc'
 
 ### Install from Git
 
@@ -142,6 +142,8 @@ Class | Method | HTTP request | Description
 *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
@@ -601,6 +603,8 @@ 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)
@@ -627,6 +631,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)
@@ -1258,6 +1264,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.98-RC | 12/15/2022 | conversation searching |
 | 4.0.97-RC | 12/13/2022 | conversations - add email and sms_phone to participant object |
 | 4.0.96-RC | 12/09/2022 | conversations - message translation |
 | 4.0.95-RC | 12/08/2022 | conversation canned messages |

data/docs/ConversationApi.md

@@ -15,6 +15,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
@@ -809,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)

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
+)
+```
+

data/docs/ConversationAutocompleteResponse.md

@@ -0,0 +1,30 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAutocompleteResponse.new(
+  error: null,
+  field: null,
+  metadata: null,
+  results: null,
+  success: null,
+  term: null,
+  warning: null
+)
+```
+

data/docs/ConversationSearchRequest.md

@@ -0,0 +1,36 @@
+# UltracartClient::ConversationSearchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_filter** | **String** |  | [optional] |
+| **language_filter** | **String** |  | [optional] |
+| **medium_filter** | **String** |  | [optional] |
+| **order_by_newest** | **Boolean** |  | [optional] |
+| **order_by_oldest** | **Boolean** |  | [optional] |
+| **range_begin** | **Integer** |  | [optional] |
+| **range_end** | **Integer** |  | [optional] |
+| **sms_phone_number_filter** | **String** |  | [optional] |
+| **text_search** | **String** |  | [optional] |
+| **visible_filter** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationSearchRequest.new(
+  email_filter: null,
+  language_filter: null,
+  medium_filter: null,
+  order_by_newest: null,
+  order_by_oldest: null,
+  range_begin: null,
+  range_end: null,
+  sms_phone_number_filter: null,
+  text_search: null,
+  visible_filter: null
+)
+```
+

data/docs/ConversationSearchResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::ConversationSearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **range_begin** | **Integer** |  | [optional] |
+| **range_end** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationSearchResponse.new(
+  range_begin: null,
+  range_end: null,
+  total: null
+)
+```
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -718,6 +718,144 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve a list of matching terms for a search field
+    # Retrieve a list of matching terms for a search field 
+    # @param autocomplete_request [ConversationAutocompleteRequest] Autocomplete Request
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationAutocompleteResponse]
+    def get_conversations_autocomplete(autocomplete_request, opts = {})
+      data, _status_code, _headers = get_conversations_autocomplete_with_http_info(autocomplete_request, opts)
+      data
+    end
+
+    # Retrieve a list of matching terms for a search field
+    # Retrieve a list of matching terms for a search field 
+    # @param autocomplete_request [ConversationAutocompleteRequest] Autocomplete Request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationAutocompleteResponse, Integer, Hash)>] ConversationAutocompleteResponse data, response status code and response headers
+    def get_conversations_autocomplete_with_http_info(autocomplete_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_autocomplete ...'
+      end
+      # verify the required parameter 'autocomplete_request' is set
+      if @api_client.config.client_side_validation && autocomplete_request.nil?
+        fail ArgumentError, "Missing the required parameter 'autocomplete_request' when calling ConversationApi.get_conversations_autocomplete"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/autocomplete'
+
+      # 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(autocomplete_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationAutocompleteResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversations_autocomplete",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversations_autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search conversations
+    # Search conversations 
+    # @param search_request [ConversationSearchRequest] Search Request
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationSearchResponse]
+    def get_conversations_search(search_request, opts = {})
+      data, _status_code, _headers = get_conversations_search_with_http_info(search_request, opts)
+      data
+    end
+
+    # Search conversations
+    # Search conversations 
+    # @param search_request [ConversationSearchRequest] Search Request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationSearchResponse, Integer, Hash)>] ConversationSearchResponse data, response status code and response headers
+    def get_conversations_search_with_http_info(search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_search ...'
+      end
+      # verify the required parameter 'search_request' is set
+      if @api_client.config.client_side_validation && search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.get_conversations_search"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/search'
+
+      # 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(search_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationSearchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversations_search",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Insert a canned message
     # Insert a canned message 
     # @param canned_message [ConversationCannedMessage] Canned message