ultracart_api 3.10.81 → 3.10.83

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06c357e935ee1e8ba7df4774cf3bb451d1bb312f791d215d785a0379ad5181ba
-  data.tar.gz: 6b6c63d5b5c705abe450b15d07ee25259091468ae3b6373437709868b4a3fa4f
+  metadata.gz: 3f9861b7b08df849bc2db24b1a7b4810fd9ddad3b674f5b0b7eb4c39c26c4b05
+  data.tar.gz: d52f5231010245d2d78d84fa72460ced53f05834bd89d97088d754b21165a192
 SHA512:
-  metadata.gz: 3c0ab1e20aa5aca0e2260d57c366ed62d7b37ac49126a6dd592a589f771ccaa03f2a65a8669612e48a850af6b1c69f5859edaf1cacfe4f157bd7ea67eb4e7fc1
-  data.tar.gz: 287a398c2da5e9a3f8312cdbb9639ceb164addbee4a494beac618c301b3e7306fb451441681792a964d3d52a8326221ac13fad546f94281c128c4b197566ec93
+  metadata.gz: f3c835a52ff5e056143d6e756e60d059672135e0085df3c73210601bb9439449ef7a6d5ab3955f515d2591801af5398cb4ba4db4be43205f704dd0ab1a567632
+  data.tar.gz: 0263f337c65ce160ae4a29aafaa7505c3c486f3a50cf509aeb9d1dcb5f91a0d1ff5f407f518ec32f2421c9d922ad51d8260067cfc84fd4318db61e2a8fd08351

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.81
+- Package version: 3.10.83
 - 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.81.gem
+gem install ./ultracart_api-3.10.83.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.81.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.83.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.81'
+    gem 'ultracart_api', '~> 3.10.83'
 
 ### Install from Git
 
@@ -599,6 +599,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
  - [UltracartClient::ConversationAutocompleteRequest](docs/ConversationAutocompleteRequest.md)
  - [UltracartClient::ConversationAutocompleteResponse](docs/ConversationAutocompleteResponse.md)
+ - [UltracartClient::ConversationAutocompleteValue](docs/ConversationAutocompleteValue.md)
  - [UltracartClient::ConversationCannedMessage](docs/ConversationCannedMessage.md)
  - [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
  - [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
@@ -609,6 +610,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationDepartmentsResponse](docs/ConversationDepartmentsResponse.md)
  - [UltracartClient::ConversationEngagement](docs/ConversationEngagement.md)
  - [UltracartClient::ConversationEngagementEquation](docs/ConversationEngagementEquation.md)
+ - [UltracartClient::ConversationEngagementEquationFunction](docs/ConversationEngagementEquationFunction.md)
+ - [UltracartClient::ConversationEngagementEquationGroup](docs/ConversationEngagementEquationGroup.md)
  - [UltracartClient::ConversationEngagementResponse](docs/ConversationEngagementResponse.md)
  - [UltracartClient::ConversationEngagementsResponse](docs/ConversationEngagementsResponse.md)
  - [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
@@ -1257,6 +1260,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.83 | 12/20/2022 | conversation engagement update |
+| 3.10.82 | 12/15/2022 | conversation search - added start date filtering |
 | 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 |

data/docs/ConversationAutocompleteResponse.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **error** | [**Error**](Error.md) |  | [optional] 
 **field** | **String** |  | [optional] 
 **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
-**results** | **Array<String>** |  | [optional] 
+**results** | [**Array<ConversationAutocompleteValue>**](ConversationAutocompleteValue.md) |  | [optional] 
 **success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
 **term** | **String** |  | [optional] 
 **warning** | [**Warning**](Warning.md) |  | [optional] 

data/docs/ConversationAutocompleteValue.md

@@ -0,0 +1,9 @@
+# UltracartClient::ConversationAutocompleteValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+

data/docs/ConversationEngagement.md

@@ -9,6 +9,6 @@ Name | Type | Description | Notes
 **engagement_name** | **String** |  | [optional] 
 **equation** | [**ConversationEngagementEquation**](ConversationEngagementEquation.md) |  | [optional] 
 **time_on_page** | **Integer** |  | [optional] 
-**visitor_type** | **String** |  | [optional] 
+**visitor_type** | **String** | The type of visitor | [optional] 
 
 

data/docs/ConversationEngagementEquation.md

@@ -3,5 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**groups** | [**Array<ConversationEngagementEquationGroup>**](ConversationEngagementEquationGroup.md) |  | [optional] 
 
 

data/docs/ConversationEngagementEquationFunction.md

@@ -0,0 +1,21 @@
+# UltracartClient::ConversationEngagementEquationFunction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**any_page_url_logic** | **String** | Logic operation to perform on an any page url function type | [optional] 
+**any_page_url_value** | **String** |  | [optional] 
+**current_page_url_logic** | **String** | Logic operation to perform on a current page url function type | [optional] 
+**current_page_url_value** | **String** |  | [optional] 
+**customers_browsing_time_logic** | **String** | Logic operation to perform on a customer's browsing time function type | [optional] 
+**customers_browsing_time_seconds** | **Integer** |  | [optional] 
+**customers_location_country** | **String** |  | [optional] 
+**customers_location_logic** | **String** | Logic operation to perform on a customer's location function type | [optional] 
+**customers_location_state** | **String** |  | [optional] 
+**number_of_viewed_pages_logic** | **String** | Logic operation to perform on a customer's browsing time function type | [optional] 
+**number_of_viewed_pages_value** | **Integer** |  | [optional] 
+**referring_website_logic** | **String** | Logic operation to perform on a referring website function type | [optional] 
+**referring_website_value** | **String** |  | [optional] 
+**type** | **String** | Type of function | [optional] 
+
+

data/docs/ConversationEngagementEquationGroup.md

@@ -0,0 +1,8 @@
+# UltracartClient::ConversationEngagementEquationGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**functions** | [**Array<ConversationEngagementEquationFunction>**](ConversationEngagementEquationFunction.md) |  | [optional] 
+
+

data/docs/ConversationSearchRequest.md

@@ -3,6 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**date_end** | **String** | End of the range | [optional] 
+**date_start** | **String** | Start of the range | [optional] 
 **email_filter** | **String** |  | [optional] 
 **language_filter** | **String** |  | [optional] 
 **medium_filter** | **String** |  | [optional] 

data/lib/ultracart_api/models/conversation_autocomplete_response.rb

@@ -48,7 +48,7 @@ module UltracartClient
         :'error' => :'Error',
         :'field' => :'String',
         :'metadata' => :'ResponseMetadata',
-        :'results' => :'Array<String>',
+        :'results' => :'Array<ConversationAutocompleteValue>',
         :'success' => :'BOOLEAN',
         :'term' => :'String',
         :'warning' => :'Warning'

data/lib/ultracart_api/models/conversation_autocomplete_value.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 ConversationAutocompleteValue
+    attr_accessor :description
+
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'description' => :'String',
+        :'value' => :'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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      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 &&
+          description == o.description &&
+          value == o.value
+    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
+      [description, value].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_engagement.rb

@@ -26,8 +26,31 @@ module UltracartClient
 
     attr_accessor :time_on_page
 
+    # The type of visitor
     attr_accessor :visitor_type
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -103,9 +126,21 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      visitor_type_validator = EnumAttributeValidator.new('String', ['all', 'first time', 'returning'])
+      return false unless visitor_type_validator.valid?(@visitor_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] visitor_type Object to be assigned
+    def visitor_type=(visitor_type)
+      validator = EnumAttributeValidator.new('String', ['all', 'first time', 'returning'])
+      unless validator.valid?(visitor_type)
+        fail ArgumentError, 'invalid value for "visitor_type", must be one of #{validator.allowable_values}.'
+      end
+      @visitor_type = visitor_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/ultracart_api/models/conversation_engagement_equation.rb

@@ -14,15 +14,19 @@ require 'date'
 
 module UltracartClient
   class ConversationEngagementEquation
+    attr_accessor :groups
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'groups' => :'groups'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'groups' => :'Array<ConversationEngagementEquationGroup>'
       }
     end
 
@@ -33,6 +37,12 @@ module UltracartClient
 
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -52,7 +62,8 @@ module UltracartClient
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
-      self.class == o.class
+      self.class == o.class &&
+          groups == o.groups
     end
 
     # @see the `==` method
@@ -64,7 +75,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [].hash
+      [groups].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_engagement_equation_function.rb

@@ -0,0 +1,414 @@
+=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 ConversationEngagementEquationFunction
+    # Logic operation to perform on an any page url function type
+    attr_accessor :any_page_url_logic
+
+    attr_accessor :any_page_url_value
+
+    # Logic operation to perform on a current page url function type
+    attr_accessor :current_page_url_logic
+
+    attr_accessor :current_page_url_value
+
+    # Logic operation to perform on a customer's browsing time function type
+    attr_accessor :customers_browsing_time_logic
+
+    attr_accessor :customers_browsing_time_seconds
+
+    attr_accessor :customers_location_country
+
+    # Logic operation to perform on a customer's location function type
+    attr_accessor :customers_location_logic
+
+    attr_accessor :customers_location_state
+
+    # Logic operation to perform on a customer's browsing time function type
+    attr_accessor :number_of_viewed_pages_logic
+
+    attr_accessor :number_of_viewed_pages_value
+
+    # Logic operation to perform on a referring website function type
+    attr_accessor :referring_website_logic
+
+    attr_accessor :referring_website_value
+
+    # Type of function
+    attr_accessor :type
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'any_page_url_logic' => :'any_page_url_logic',
+        :'any_page_url_value' => :'any_page_url_value',
+        :'current_page_url_logic' => :'current_page_url_logic',
+        :'current_page_url_value' => :'current_page_url_value',
+        :'customers_browsing_time_logic' => :'customers_browsing_time_logic',
+        :'customers_browsing_time_seconds' => :'customers_browsing_time_seconds',
+        :'customers_location_country' => :'customers_location_country',
+        :'customers_location_logic' => :'customers_location_logic',
+        :'customers_location_state' => :'customers_location_state',
+        :'number_of_viewed_pages_logic' => :'number_of_viewed_pages_logic',
+        :'number_of_viewed_pages_value' => :'number_of_viewed_pages_value',
+        :'referring_website_logic' => :'referring_website_logic',
+        :'referring_website_value' => :'referring_website_value',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'any_page_url_logic' => :'String',
+        :'any_page_url_value' => :'String',
+        :'current_page_url_logic' => :'String',
+        :'current_page_url_value' => :'String',
+        :'customers_browsing_time_logic' => :'String',
+        :'customers_browsing_time_seconds' => :'Integer',
+        :'customers_location_country' => :'String',
+        :'customers_location_logic' => :'String',
+        :'customers_location_state' => :'String',
+        :'number_of_viewed_pages_logic' => :'String',
+        :'number_of_viewed_pages_value' => :'Integer',
+        :'referring_website_logic' => :'String',
+        :'referring_website_value' => :'String',
+        :'type' => :'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?(:'any_page_url_logic')
+        self.any_page_url_logic = attributes[:'any_page_url_logic']
+      end
+
+      if attributes.has_key?(:'any_page_url_value')
+        self.any_page_url_value = attributes[:'any_page_url_value']
+      end
+
+      if attributes.has_key?(:'current_page_url_logic')
+        self.current_page_url_logic = attributes[:'current_page_url_logic']
+      end
+
+      if attributes.has_key?(:'current_page_url_value')
+        self.current_page_url_value = attributes[:'current_page_url_value']
+      end
+
+      if attributes.has_key?(:'customers_browsing_time_logic')
+        self.customers_browsing_time_logic = attributes[:'customers_browsing_time_logic']
+      end
+
+      if attributes.has_key?(:'customers_browsing_time_seconds')
+        self.customers_browsing_time_seconds = attributes[:'customers_browsing_time_seconds']
+      end
+
+      if attributes.has_key?(:'customers_location_country')
+        self.customers_location_country = attributes[:'customers_location_country']
+      end
+
+      if attributes.has_key?(:'customers_location_logic')
+        self.customers_location_logic = attributes[:'customers_location_logic']
+      end
+
+      if attributes.has_key?(:'customers_location_state')
+        self.customers_location_state = attributes[:'customers_location_state']
+      end
+
+      if attributes.has_key?(:'number_of_viewed_pages_logic')
+        self.number_of_viewed_pages_logic = attributes[:'number_of_viewed_pages_logic']
+      end
+
+      if attributes.has_key?(:'number_of_viewed_pages_value')
+        self.number_of_viewed_pages_value = attributes[:'number_of_viewed_pages_value']
+      end
+
+      if attributes.has_key?(:'referring_website_logic')
+        self.referring_website_logic = attributes[:'referring_website_logic']
+      end
+
+      if attributes.has_key?(:'referring_website_value')
+        self.referring_website_value = attributes[:'referring_website_value']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      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?
+      any_page_url_logic_validator = EnumAttributeValidator.new('String', ['contains', 'does not contain', 'is exactly', 'is not'])
+      return false unless any_page_url_logic_validator.valid?(@any_page_url_logic)
+      current_page_url_logic_validator = EnumAttributeValidator.new('String', ['contains', 'does not contain', 'is exactly', 'is not'])
+      return false unless current_page_url_logic_validator.valid?(@current_page_url_logic)
+      customers_browsing_time_logic_validator = EnumAttributeValidator.new('String', ['is at least', 'is more than', 'is less than', 'is at most'])
+      return false unless customers_browsing_time_logic_validator.valid?(@customers_browsing_time_logic)
+      customers_location_logic_validator = EnumAttributeValidator.new('String', ['is', 'is not'])
+      return false unless customers_location_logic_validator.valid?(@customers_location_logic)
+      number_of_viewed_pages_logic_validator = EnumAttributeValidator.new('String', ['is at least', 'is more than', 'is less than', 'is at most'])
+      return false unless number_of_viewed_pages_logic_validator.valid?(@number_of_viewed_pages_logic)
+      referring_website_logic_validator = EnumAttributeValidator.new('String', ['contains', 'does not contain', 'is exactly', 'is not'])
+      return false unless referring_website_logic_validator.valid?(@referring_website_logic)
+      type_validator = EnumAttributeValidator.new('String', ['current page url', 'customer's location', 'customer's browsing time', 'number of viewed pages', 'referring website address', 'any page from session'])
+      return false unless type_validator.valid?(@type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] any_page_url_logic Object to be assigned
+    def any_page_url_logic=(any_page_url_logic)
+      validator = EnumAttributeValidator.new('String', ['contains', 'does not contain', 'is exactly', 'is not'])
+      unless validator.valid?(any_page_url_logic)
+        fail ArgumentError, 'invalid value for "any_page_url_logic", must be one of #{validator.allowable_values}.'
+      end
+      @any_page_url_logic = any_page_url_logic
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] current_page_url_logic Object to be assigned
+    def current_page_url_logic=(current_page_url_logic)
+      validator = EnumAttributeValidator.new('String', ['contains', 'does not contain', 'is exactly', 'is not'])
+      unless validator.valid?(current_page_url_logic)
+        fail ArgumentError, 'invalid value for "current_page_url_logic", must be one of #{validator.allowable_values}.'
+      end
+      @current_page_url_logic = current_page_url_logic
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] customers_browsing_time_logic Object to be assigned
+    def customers_browsing_time_logic=(customers_browsing_time_logic)
+      validator = EnumAttributeValidator.new('String', ['is at least', 'is more than', 'is less than', 'is at most'])
+      unless validator.valid?(customers_browsing_time_logic)
+        fail ArgumentError, 'invalid value for "customers_browsing_time_logic", must be one of #{validator.allowable_values}.'
+      end
+      @customers_browsing_time_logic = customers_browsing_time_logic
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] customers_location_logic Object to be assigned
+    def customers_location_logic=(customers_location_logic)
+      validator = EnumAttributeValidator.new('String', ['is', 'is not'])
+      unless validator.valid?(customers_location_logic)
+        fail ArgumentError, 'invalid value for "customers_location_logic", must be one of #{validator.allowable_values}.'
+      end
+      @customers_location_logic = customers_location_logic
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] number_of_viewed_pages_logic Object to be assigned
+    def number_of_viewed_pages_logic=(number_of_viewed_pages_logic)
+      validator = EnumAttributeValidator.new('String', ['is at least', 'is more than', 'is less than', 'is at most'])
+      unless validator.valid?(number_of_viewed_pages_logic)
+        fail ArgumentError, 'invalid value for "number_of_viewed_pages_logic", must be one of #{validator.allowable_values}.'
+      end
+      @number_of_viewed_pages_logic = number_of_viewed_pages_logic
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] referring_website_logic Object to be assigned
+    def referring_website_logic=(referring_website_logic)
+      validator = EnumAttributeValidator.new('String', ['contains', 'does not contain', 'is exactly', 'is not'])
+      unless validator.valid?(referring_website_logic)
+        fail ArgumentError, 'invalid value for "referring_website_logic", must be one of #{validator.allowable_values}.'
+      end
+      @referring_website_logic = referring_website_logic
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ['current page url', 'customer's location', 'customer's browsing time', 'number of viewed pages', 'referring website address', 'any page from session'])
+      unless validator.valid?(type)
+        fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
+      end
+      @type = type
+    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 &&
+          any_page_url_logic == o.any_page_url_logic &&
+          any_page_url_value == o.any_page_url_value &&
+          current_page_url_logic == o.current_page_url_logic &&
+          current_page_url_value == o.current_page_url_value &&
+          customers_browsing_time_logic == o.customers_browsing_time_logic &&
+          customers_browsing_time_seconds == o.customers_browsing_time_seconds &&
+          customers_location_country == o.customers_location_country &&
+          customers_location_logic == o.customers_location_logic &&
+          customers_location_state == o.customers_location_state &&
+          number_of_viewed_pages_logic == o.number_of_viewed_pages_logic &&
+          number_of_viewed_pages_value == o.number_of_viewed_pages_value &&
+          referring_website_logic == o.referring_website_logic &&
+          referring_website_value == o.referring_website_value &&
+          type == o.type
+    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
+      [any_page_url_logic, any_page_url_value, current_page_url_logic, current_page_url_value, customers_browsing_time_logic, customers_browsing_time_seconds, customers_location_country, customers_location_logic, customers_location_state, number_of_viewed_pages_logic, number_of_viewed_pages_value, referring_website_logic, referring_website_value, type].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_engagement_equation_group.rb

@@ -0,0 +1,186 @@
+=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 ConversationEngagementEquationGroup
+    attr_accessor :functions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'functions' => :'functions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'functions' => :'Array<ConversationEngagementEquationFunction>'
+      }
+    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?(:'functions')
+        if (value = attributes[:'functions']).is_a?(Array)
+          self.functions = value
+        end
+      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 &&
+          functions == o.functions
+    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
+      [functions].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

@@ -14,6 +14,12 @@ require 'date'
 
 module UltracartClient
   class ConversationSearchRequest
+    # End of the range
+    attr_accessor :date_end
+
+    # Start of the range
+    attr_accessor :date_start
+
     attr_accessor :email_filter
 
     attr_accessor :language_filter
@@ -37,6 +43,8 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'date_end' => :'date_end',
+        :'date_start' => :'date_start',
         :'email_filter' => :'email_filter',
         :'language_filter' => :'language_filter',
         :'medium_filter' => :'medium_filter',
@@ -53,6 +61,8 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'date_end' => :'String',
+        :'date_start' => :'String',
         :'email_filter' => :'String',
         :'language_filter' => :'String',
         :'medium_filter' => :'String',
@@ -74,6 +84,14 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'date_end')
+        self.date_end = attributes[:'date_end']
+      end
+
+      if attributes.has_key?(:'date_start')
+        self.date_start = attributes[:'date_start']
+      end
+
       if attributes.has_key?(:'email_filter')
         self.email_filter = attributes[:'email_filter']
       end
@@ -133,6 +151,8 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          date_end == o.date_end &&
+          date_start == o.date_start &&
           email_filter == o.email_filter &&
           language_filter == o.language_filter &&
           medium_filter == o.medium_filter &&
@@ -154,7 +174,7 @@ module UltracartClient
     # 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
+      [date_end, date_start, 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

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -140,6 +140,7 @@ 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_autocomplete_value'
 require 'ultracart_api/models/conversation_canned_message'
 require 'ultracart_api/models/conversation_canned_message_response'
 require 'ultracart_api/models/conversation_canned_messages_response'
@@ -150,6 +151,8 @@ require 'ultracart_api/models/conversation_department_settings'
 require 'ultracart_api/models/conversation_departments_response'
 require 'ultracart_api/models/conversation_engagement'
 require 'ultracart_api/models/conversation_engagement_equation'
+require 'ultracart_api/models/conversation_engagement_equation_function'
+require 'ultracart_api/models/conversation_engagement_equation_group'
 require 'ultracart_api/models/conversation_engagement_response'
 require 'ultracart_api/models/conversation_engagements_response'
 require 'ultracart_api/models/conversation_event_add_coupon'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.81
+  version: 3.10.83
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-15 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -350,6 +350,7 @@ files:
 - docs/ConversationApi.md
 - docs/ConversationAutocompleteRequest.md
 - docs/ConversationAutocompleteResponse.md
+- docs/ConversationAutocompleteValue.md
 - docs/ConversationCannedMessage.md
 - docs/ConversationCannedMessageResponse.md
 - docs/ConversationCannedMessagesResponse.md
@@ -360,6 +361,8 @@ files:
 - docs/ConversationDepartmentsResponse.md
 - docs/ConversationEngagement.md
 - docs/ConversationEngagementEquation.md
+- docs/ConversationEngagementEquationFunction.md
+- docs/ConversationEngagementEquationGroup.md
 - docs/ConversationEngagementResponse.md
 - docs/ConversationEngagementsResponse.md
 - docs/ConversationEventAddCoupon.md
@@ -1098,6 +1101,7 @@ files:
 - 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_autocomplete_value.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
@@ -1108,6 +1112,8 @@ files:
 - lib/ultracart_api/models/conversation_departments_response.rb
 - lib/ultracart_api/models/conversation_engagement.rb
 - lib/ultracart_api/models/conversation_engagement_equation.rb
+- lib/ultracart_api/models/conversation_engagement_equation_function.rb
+- lib/ultracart_api/models/conversation_engagement_equation_group.rb
 - lib/ultracart_api/models/conversation_engagement_response.rb
 - lib/ultracart_api/models/conversation_engagements_response.rb
 - lib/ultracart_api/models/conversation_event_add_coupon.rb