ultracart_api 3.10.67 → 3.10.69

data/lib/ultracart_api/models/conversation_webchat_context.rb

@@ -0,0 +1,222 @@
+=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 ConversationWebchatContext
+    attr_accessor :cart
+
+    attr_accessor :current_url
+
+    attr_accessor :page_view
+
+    attr_accessor :session_start
+
+    attr_accessor :session_utm
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cart' => :'cart',
+        :'current_url' => :'current_url',
+        :'page_view' => :'page_view',
+        :'session_start' => :'session_start',
+        :'session_utm' => :'session_utm'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cart' => :'Cart',
+        :'current_url' => :'String',
+        :'page_view' => :'Array<HitPageView>',
+        :'session_start' => :'HitSessionStart',
+        :'session_utm' => :'HitSessionUtm'
+      }
+    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?(:'cart')
+        self.cart = attributes[:'cart']
+      end
+
+      if attributes.has_key?(:'current_url')
+        self.current_url = attributes[:'current_url']
+      end
+
+      if attributes.has_key?(:'page_view')
+        if (value = attributes[:'page_view']).is_a?(Array)
+          self.page_view = value
+        end
+      end
+
+      if attributes.has_key?(:'session_start')
+        self.session_start = attributes[:'session_start']
+      end
+
+      if attributes.has_key?(:'session_utm')
+        self.session_utm = attributes[:'session_utm']
+      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 &&
+          cart == o.cart &&
+          current_url == o.current_url &&
+          page_view == o.page_view &&
+          session_start == o.session_start &&
+          session_utm == o.session_utm
+    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
+      [cart, current_url, page_view, session_start, session_utm].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_websocket_message.rb

@@ -44,6 +44,8 @@ module UltracartClient
 
     attr_accessor :event_updated_message
 
+    attr_accessor :event_webchat_context
+
     attr_accessor :message
 
     # Type of message
@@ -88,6 +90,7 @@ module UltracartClient
         :'event_type' => :'event_type',
         :'event_typing' => :'event_typing',
         :'event_updated_message' => :'event_updated_message',
+        :'event_webchat_context' => :'event_webchat_context',
         :'message' => :'message',
         :'type' => :'type'
       }
@@ -110,6 +113,7 @@ module UltracartClient
         :'event_type' => :'String',
         :'event_typing' => :'ConversationEventTyping',
         :'event_updated_message' => :'ConversationMessage',
+        :'event_webchat_context' => :'ConversationEventWebchatContext',
         :'message' => :'ConversationMessage',
         :'type' => :'String'
       }
@@ -179,6 +183,10 @@ module UltracartClient
         self.event_updated_message = attributes[:'event_updated_message']
       end
 
+      if attributes.has_key?(:'event_webchat_context')
+        self.event_webchat_context = attributes[:'event_webchat_context']
+      end
+
       if attributes.has_key?(:'message')
         self.message = attributes[:'message']
       end
@@ -198,7 +206,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item'])
+      event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item', 'webchat context'])
       return false unless event_type_validator.valid?(@event_type)
       type_validator = EnumAttributeValidator.new('String', ['message', 'event', 'ping', 'check queue position'])
       return false unless type_validator.valid?(@type)
@@ -208,7 +216,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] event_type Object to be assigned
     def event_type=(event_type)
-      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item'])
+      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item', 'webchat context'])
       unless validator.valid?(event_type)
         fail ArgumentError, 'invalid value for "event_type", must be one of #{validator.allowable_values}.'
       end
@@ -244,6 +252,7 @@ module UltracartClient
           event_type == o.event_type &&
           event_typing == o.event_typing &&
           event_updated_message == o.event_updated_message &&
+          event_webchat_context == o.event_webchat_context &&
           message == o.message &&
           type == o.type
     end
@@ -257,7 +266,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [conversation_uuid, event_add_coupon, event_add_item, event_conversation_closed, event_new_conversation, event_new_message, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, message, type].hash
+      [conversation_uuid, event_add_coupon, event_add_item, event_conversation_closed, event_new_conversation, event_new_message, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, event_webchat_context, message, type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/hit_page_view.rb

@@ -0,0 +1,276 @@
+=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 HitPageView
+    attr_accessor :bounce
+
+    attr_accessor :meta_data
+
+    attr_accessor :method
+
+    attr_accessor :prefetch
+
+    attr_accessor :query
+
+    attr_accessor :recording
+
+    attr_accessor :redirect
+
+    attr_accessor :referrer
+
+    attr_accessor :time_on_page
+
+    attr_accessor :title
+
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bounce' => :'bounce',
+        :'meta_data' => :'meta_data',
+        :'method' => :'method',
+        :'prefetch' => :'prefetch',
+        :'query' => :'query',
+        :'recording' => :'recording',
+        :'redirect' => :'redirect',
+        :'referrer' => :'referrer',
+        :'time_on_page' => :'time_on_page',
+        :'title' => :'title',
+        :'url' => :'url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'bounce' => :'BOOLEAN',
+        :'meta_data' => :'Array<HitPageViewMetaData>',
+        :'method' => :'String',
+        :'prefetch' => :'BOOLEAN',
+        :'query' => :'String',
+        :'recording' => :'BOOLEAN',
+        :'redirect' => :'BOOLEAN',
+        :'referrer' => :'String',
+        :'time_on_page' => :'Float',
+        :'title' => :'String',
+        :'url' => :'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?(:'bounce')
+        self.bounce = attributes[:'bounce']
+      end
+
+      if attributes.has_key?(:'meta_data')
+        if (value = attributes[:'meta_data']).is_a?(Array)
+          self.meta_data = value
+        end
+      end
+
+      if attributes.has_key?(:'method')
+        self.method = attributes[:'method']
+      end
+
+      if attributes.has_key?(:'prefetch')
+        self.prefetch = attributes[:'prefetch']
+      end
+
+      if attributes.has_key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.has_key?(:'recording')
+        self.recording = attributes[:'recording']
+      end
+
+      if attributes.has_key?(:'redirect')
+        self.redirect = attributes[:'redirect']
+      end
+
+      if attributes.has_key?(:'referrer')
+        self.referrer = attributes[:'referrer']
+      end
+
+      if attributes.has_key?(:'time_on_page')
+        self.time_on_page = attributes[:'time_on_page']
+      end
+
+      if attributes.has_key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.has_key?(:'url')
+        self.url = attributes[:'url']
+      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 &&
+          bounce == o.bounce &&
+          meta_data == o.meta_data &&
+          method == o.method &&
+          prefetch == o.prefetch &&
+          query == o.query &&
+          recording == o.recording &&
+          redirect == o.redirect &&
+          referrer == o.referrer &&
+          time_on_page == o.time_on_page &&
+          title == o.title &&
+          url == o.url
+    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
+      [bounce, meta_data, method, prefetch, query, recording, redirect, referrer, time_on_page, title, url].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