ultracart_api 4.0.98.rc → 4.0.100.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ee5f9abeb411470c29cb95f24580158cd0b9f891b0a297d7ce27ad4a752e652
-  data.tar.gz: b489c4b7819f86834f4290065706a4679b6467d843f98c8eb62a57267f11fc82
+  metadata.gz: 762a40805b652da96c82cdb8b5608aa7907bf3e5d962809c49436bc9e01c249e
+  data.tar.gz: 4895f6e1529dc3b54b6b6c8281a7f1def6f10ae00e2451f4074c612c73d99591
 SHA512:
-  metadata.gz: 74d4456113d178782aa23cea2c215480b4aa549e5b465828f1bbb9fcb5a9bdf7e15fab7c405e2a0b8fb278d868fa2c17f0c7363bcc0d53e1353cc439c49557ce
-  data.tar.gz: eb763b16714e71ca3d699c3dd6fd074d6b1953c2b68aa38edbf6f7331d60cbd45bdde27f7ebb158f5311cf2912bd025298a3723058c839f71b0dcfd0d40a6018
+  metadata.gz: 37ab770d394b689a6179d781fe60a11dc5d1ba84fb0f35bfa0c1b93c9e5db9e530516708fe5336093da1e6882ba90b47c74882347cbd5eab76b1fac0a2f69c0d
+  data.tar.gz: 4e949dad14070dce9a6e84a48fee5c2e54f570d513aaffadb104993cc2857c18b2e88421372dd4e1b86a324b4d4f5d74fce30cc93f0461bc83cde7b490ce26b0

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.98.rc
+- Package version: 4.0.100.rc
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.98.rc.gem
+gem install ./ultracart_api-4.0.100.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.98.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.100.rc.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 4.0.98.rc'
+    gem 'ultracart_api', '~> 4.0.100.rc'
 
 ### Install from Git
 
@@ -605,6 +605,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)
@@ -613,6 +614,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationDepartmentResponse](docs/ConversationDepartmentResponse.md)
  - [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)
@@ -1264,6 +1268,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.100-RC | 12/20/2022 | conversation engagement update |
+| 4.0.99-RC | 12/15/2022 | conversation search - added start date filtering |
 | 4.0.98-RC | 12/15/2022 | conversation searching |
 | 4.0.97-RC | 12/13/2022 | conversations - add email and sms_phone to participant object |
 | 4.0.96-RC | 12/09/2022 | conversations - message translation |

data/docs/ConversationAutocompleteResponse.md

@@ -7,7 +7,7 @@
 | **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,20 @@
+# UltracartClient::ConversationAutocompleteValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  | [optional] |
+| **value** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAutocompleteValue.new(
+  description: null,
+  value: null
+)
+```
+

data/docs/ConversationEngagement.md

@@ -8,9 +8,9 @@
 | **customer_greeting** | **String** |  | [optional] |
 | **department_oids** | **Array<Integer>** |  | [optional] |
 | **engagement_name** | **String** |  | [optional] |
-| **equation** | **Object** |  | [optional] |
+| **equation** | [**ConversationEngagementEquation**](ConversationEngagementEquation.md) |  | [optional] |
 | **time_on_page** | **Integer** |  | [optional] |
-| **visitor_type** | **String** |  | [optional] |
+| **visitor_type** | **String** | The type of visitor | [optional] |
 
 ## Example
 

data/docs/ConversationEngagementEquation.md

@@ -0,0 +1,18 @@
+# UltracartClient::ConversationEngagementEquation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **groups** | [**Array<ConversationEngagementEquationGroup>**](ConversationEngagementEquationGroup.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationEngagementEquation.new(
+  groups: null
+)
+```
+

data/docs/ConversationEngagementEquationFunction.md

@@ -0,0 +1,44 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationEngagementEquationFunction.new(
+  any_page_url_logic: null,
+  any_page_url_value: null,
+  current_page_url_logic: null,
+  current_page_url_value: null,
+  customers_browsing_time_logic: null,
+  customers_browsing_time_seconds: null,
+  customers_location_country: null,
+  customers_location_logic: null,
+  customers_location_state: null,
+  number_of_viewed_pages_logic: null,
+  number_of_viewed_pages_value: null,
+  referring_website_logic: null,
+  referring_website_value: null,
+  type: null
+)
+```
+

data/docs/ConversationEngagementEquationGroup.md

@@ -0,0 +1,18 @@
+# UltracartClient::ConversationEngagementEquationGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **functions** | [**Array<ConversationEngagementEquationFunction>**](ConversationEngagementEquationFunction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationEngagementEquationGroup.new(
+  functions: null
+)
+```
+

data/docs/ConversationSearchRequest.md

@@ -4,6 +4,8 @@
 
 | 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] |
@@ -21,6 +23,8 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ConversationSearchRequest.new(
+  date_end: null,
+  date_start: null,
   email_filter: null,
   language_filter: null,
   medium_filter: null,

data/lib/ultracart_api/models/conversation_autocomplete_response.rb

@@ -54,7 +54,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,228 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+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
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'String',
+        :'value' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationAutocompleteValue` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationAutocompleteValue`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.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 [Integer] 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 self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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

@@ -27,8 +27,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
       {
@@ -54,7 +77,7 @@ module UltracartClient
         :'customer_greeting' => :'String',
         :'department_oids' => :'Array<Integer>',
         :'engagement_name' => :'String',
-        :'equation' => :'Object',
+        :'equation' => :'ConversationEngagementEquation',
         :'time_on_page' => :'Integer',
         :'visitor_type' => :'String'
       }
@@ -122,9 +145,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)