ultracart_api 3.10.80 → 3.10.81

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b6a4f696143d6c4b507ba947b4546b37a161906814a0907c6eebf351ff1f71d
-  data.tar.gz: 19662799cfbf6a3850df1d3493a296d9ed11538d82e1dbb6e41d75c3980b6423
+  metadata.gz: 06c357e935ee1e8ba7df4774cf3bb451d1bb312f791d215d785a0379ad5181ba
+  data.tar.gz: 6b6c63d5b5c705abe450b15d07ee25259091468ae3b6373437709868b4a3fa4f
 SHA512:
-  metadata.gz: 8a31b0c962791a1220f043729e5f0d70820118c1c8e142db6916604e5387bd0c0b113036686942959a7d17669e3c7424bf17bf5944a6283489f935c2a4cf694f
-  data.tar.gz: 8421b0a573e868534462320dafda3dcaecb8bc9e3f6dad03c2e427e759be3b91de676c4bfb40460d3d51b29168300acda10ff9485d1b05d26a1a66e0f50a0f33
+  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.80
+- 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.80.gem
+gem install ./ultracart_api-3.10.81.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.80.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.80'
+    gem 'ultracart_api', '~> 3.10.81'
 
 ### Install from Git
 
@@ -136,6 +136,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
@@ -595,6 +597,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)
@@ -623,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)
@@ -1251,6 +1257,7 @@ 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 |

data/docs/ConversationApi.md

@@ -15,6 +15,8 @@ Method | HTTP request | Description
 [**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
@@ -566,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)
 

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/ConversationSearchRequest.md

@@ -0,0 +1,17 @@
+# 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] 
+
+

data/docs/ConversationSearchResponse.md

@@ -0,0 +1,10 @@
+# UltracartClient::ConversationSearchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**range_begin** | **Integer** |  | [optional] 
+**range_end** | **Integer** |  | [optional] 
+**total** | **Integer** |  | [optional] 
+
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -618,6 +618,116 @@ module UltracartClient
       end
       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 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 Autocomplete Request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationAutocompleteResponse, Fixnum, 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 = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(autocomplete_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ConversationAutocompleteResponse')
+      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 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 Search Request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationSearchResponse, Fixnum, 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 = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(search_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ConversationSearchResponse')
+      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 Canned message

data/lib/ultracart_api/models/conversation_autocomplete_request.rb

@@ -0,0 +1,193 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationAutocompleteRequest
+    attr_accessor :field
+
+    attr_accessor :term
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'field' => :'field',
+        :'term' => :'term'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'field' => :'String',
+        :'term' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'field')
+        self.field = attributes[:'field']
+      end
+
+      if attributes.has_key?(:'term')
+        self.term = attributes[:'term']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          field == o.field &&
+          term == o.term
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [field, term].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/conversation_autocomplete_response.rb

@@ -0,0 +1,241 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationAutocompleteResponse
+    attr_accessor :error
+
+    attr_accessor :field
+
+    attr_accessor :metadata
+
+    attr_accessor :results
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :term
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'field' => :'field',
+        :'metadata' => :'metadata',
+        :'results' => :'results',
+        :'success' => :'success',
+        :'term' => :'term',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'Error',
+        :'field' => :'String',
+        :'metadata' => :'ResponseMetadata',
+        :'results' => :'Array<String>',
+        :'success' => :'BOOLEAN',
+        :'term' => :'String',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'field')
+        self.field = attributes[:'field']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'results')
+        if (value = attributes[:'results']).is_a?(Array)
+          self.results = value
+        end
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'term')
+        self.term = attributes[:'term']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          error == o.error &&
+          field == o.field &&
+          metadata == o.metadata &&
+          results == o.results &&
+          success == o.success &&
+          term == o.term &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [error, field, metadata, results, success, term, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/conversation_search_request.rb

@@ -0,0 +1,265 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationSearchRequest
+    attr_accessor :email_filter
+
+    attr_accessor :language_filter
+
+    attr_accessor :medium_filter
+
+    attr_accessor :order_by_newest
+
+    attr_accessor :order_by_oldest
+
+    attr_accessor :range_begin
+
+    attr_accessor :range_end
+
+    attr_accessor :sms_phone_number_filter
+
+    attr_accessor :text_search
+
+    attr_accessor :visible_filter
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email_filter' => :'email_filter',
+        :'language_filter' => :'language_filter',
+        :'medium_filter' => :'medium_filter',
+        :'order_by_newest' => :'order_by_newest',
+        :'order_by_oldest' => :'order_by_oldest',
+        :'range_begin' => :'range_begin',
+        :'range_end' => :'range_end',
+        :'sms_phone_number_filter' => :'sms_phone_number_filter',
+        :'text_search' => :'text_search',
+        :'visible_filter' => :'visible_filter'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email_filter' => :'String',
+        :'language_filter' => :'String',
+        :'medium_filter' => :'String',
+        :'order_by_newest' => :'BOOLEAN',
+        :'order_by_oldest' => :'BOOLEAN',
+        :'range_begin' => :'Integer',
+        :'range_end' => :'Integer',
+        :'sms_phone_number_filter' => :'String',
+        :'text_search' => :'String',
+        :'visible_filter' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'email_filter')
+        self.email_filter = attributes[:'email_filter']
+      end
+
+      if attributes.has_key?(:'language_filter')
+        self.language_filter = attributes[:'language_filter']
+      end
+
+      if attributes.has_key?(:'medium_filter')
+        self.medium_filter = attributes[:'medium_filter']
+      end
+
+      if attributes.has_key?(:'order_by_newest')
+        self.order_by_newest = attributes[:'order_by_newest']
+      end
+
+      if attributes.has_key?(:'order_by_oldest')
+        self.order_by_oldest = attributes[:'order_by_oldest']
+      end
+
+      if attributes.has_key?(:'range_begin')
+        self.range_begin = attributes[:'range_begin']
+      end
+
+      if attributes.has_key?(:'range_end')
+        self.range_end = attributes[:'range_end']
+      end
+
+      if attributes.has_key?(:'sms_phone_number_filter')
+        self.sms_phone_number_filter = attributes[:'sms_phone_number_filter']
+      end
+
+      if attributes.has_key?(:'text_search')
+        self.text_search = attributes[:'text_search']
+      end
+
+      if attributes.has_key?(:'visible_filter')
+        self.visible_filter = attributes[:'visible_filter']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          email_filter == o.email_filter &&
+          language_filter == o.language_filter &&
+          medium_filter == o.medium_filter &&
+          order_by_newest == o.order_by_newest &&
+          order_by_oldest == o.order_by_oldest &&
+          range_begin == o.range_begin &&
+          range_end == o.range_end &&
+          sms_phone_number_filter == o.sms_phone_number_filter &&
+          text_search == o.text_search &&
+          visible_filter == o.visible_filter
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [email_filter, language_filter, medium_filter, order_by_newest, order_by_oldest, range_begin, range_end, sms_phone_number_filter, text_search, visible_filter].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/conversation_search_response.rb

@@ -0,0 +1,202 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationSearchResponse
+    attr_accessor :range_begin
+
+    attr_accessor :range_end
+
+    attr_accessor :total
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'range_begin' => :'range_begin',
+        :'range_end' => :'range_end',
+        :'total' => :'total'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'range_begin' => :'Integer',
+        :'range_end' => :'Integer',
+        :'total' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'range_begin')
+        self.range_begin = attributes[:'range_begin']
+      end
+
+      if attributes.has_key?(:'range_end')
+        self.range_end = attributes[:'range_end']
+      end
+
+      if attributes.has_key?(:'total')
+        self.total = attributes[:'total']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          range_begin == o.range_begin &&
+          range_end == o.range_end &&
+          total == o.total
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [range_begin, range_end, total].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -138,6 +138,8 @@ require 'ultracart_api/models/city_state_zip'
 require 'ultracart_api/models/conversation'
 require 'ultracart_api/models/conversation_agent_auth'
 require 'ultracart_api/models/conversation_agent_auth_response'
+require 'ultracart_api/models/conversation_autocomplete_request'
+require 'ultracart_api/models/conversation_autocomplete_response'
 require 'ultracart_api/models/conversation_canned_message'
 require 'ultracart_api/models/conversation_canned_message_response'
 require 'ultracart_api/models/conversation_canned_messages_response'
@@ -166,6 +168,8 @@ require 'ultracart_api/models/conversation_multimedia_upload_url'
 require 'ultracart_api/models/conversation_multimedia_upload_url_response'
 require 'ultracart_api/models/conversation_participant'
 require 'ultracart_api/models/conversation_response'
+require 'ultracart_api/models/conversation_search_request'
+require 'ultracart_api/models/conversation_search_response'
 require 'ultracart_api/models/conversation_start_request'
 require 'ultracart_api/models/conversation_start_response'
 require 'ultracart_api/models/conversation_summary'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.80
+  version: 3.10.81
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -348,6 +348,8 @@ files:
 - docs/ConversationAgentAuth.md
 - docs/ConversationAgentAuthResponse.md
 - docs/ConversationApi.md
+- docs/ConversationAutocompleteRequest.md
+- docs/ConversationAutocompleteResponse.md
 - docs/ConversationCannedMessage.md
 - docs/ConversationCannedMessageResponse.md
 - docs/ConversationCannedMessagesResponse.md
@@ -376,6 +378,8 @@ files:
 - docs/ConversationMultimediaUploadUrlResponse.md
 - docs/ConversationParticipant.md
 - docs/ConversationResponse.md
+- docs/ConversationSearchRequest.md
+- docs/ConversationSearchResponse.md
 - docs/ConversationStartRequest.md
 - docs/ConversationStartResponse.md
 - docs/ConversationSummary.md
@@ -1092,6 +1096,8 @@ files:
 - lib/ultracart_api/models/conversation.rb
 - lib/ultracart_api/models/conversation_agent_auth.rb
 - lib/ultracart_api/models/conversation_agent_auth_response.rb
+- lib/ultracart_api/models/conversation_autocomplete_request.rb
+- lib/ultracart_api/models/conversation_autocomplete_response.rb
 - lib/ultracart_api/models/conversation_canned_message.rb
 - lib/ultracart_api/models/conversation_canned_message_response.rb
 - lib/ultracart_api/models/conversation_canned_messages_response.rb
@@ -1120,6 +1126,8 @@ files:
 - lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb
 - lib/ultracart_api/models/conversation_participant.rb
 - lib/ultracart_api/models/conversation_response.rb
+- lib/ultracart_api/models/conversation_search_request.rb
+- lib/ultracart_api/models/conversation_search_response.rb
 - lib/ultracart_api/models/conversation_start_request.rb
 - lib/ultracart_api/models/conversation_start_response.rb
 - lib/ultracart_api/models/conversation_summary.rb