ultracart_api 3.10.29 → 3.10.32

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

@@ -29,8 +29,33 @@ module UltracartClient
 
     attr_accessor :transport_statuses
 
+    # Message type
+    attr_accessor :type
+
     attr_accessor :upload_keys
 
+    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
       {
@@ -41,6 +66,7 @@ module UltracartClient
         :'media_urls' => :'media_urls',
         :'message_dts' => :'message_dts',
         :'transport_statuses' => :'transport_statuses',
+        :'type' => :'type',
         :'upload_keys' => :'upload_keys'
       }
     end
@@ -55,6 +81,7 @@ module UltracartClient
         :'media_urls' => :'Array<String>',
         :'message_dts' => :'String',
         :'transport_statuses' => :'Array<ConversationMessageTransportStatus>',
+        :'type' => :'String',
         :'upload_keys' => :'Array<String>'
       }
     end
@@ -99,6 +126,10 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
       if attributes.has_key?(:'upload_keys')
         if (value = attributes[:'upload_keys']).is_a?(Array)
           self.upload_keys = value
@@ -116,9 +147,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?
+      type_validator = EnumAttributeValidator.new('String', ['message', 'notice'])
+      return false unless type_validator.valid?(@type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ['message', 'notice'])
+      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)
@@ -131,6 +174,7 @@ module UltracartClient
           media_urls == o.media_urls &&
           message_dts == o.message_dts &&
           transport_statuses == o.transport_statuses &&
+          type == o.type &&
           upload_keys == o.upload_keys
     end
 
@@ -143,7 +187,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, media_urls, message_dts, transport_statuses, upload_keys].hash
+      [author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, media_urls, message_dts, transport_statuses, type, upload_keys].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_websocket_message.rb

@@ -27,9 +27,13 @@ module UltracartClient
 
     attr_accessor :event_queue_status_update
 
+    attr_accessor :event_rrweb
+
     # Type of event
     attr_accessor :event_type
 
+    attr_accessor :event_typing
+
     attr_accessor :event_updated_message
 
     attr_accessor :message
@@ -68,7 +72,9 @@ module UltracartClient
         :'event_new_message' => :'event_new_message',
         :'event_queue_position' => :'event_queue_position',
         :'event_queue_status_update' => :'event_queue_status_update',
+        :'event_rrweb' => :'event_rrweb',
         :'event_type' => :'event_type',
+        :'event_typing' => :'event_typing',
         :'event_updated_message' => :'event_updated_message',
         :'message' => :'message',
         :'type' => :'type'
@@ -84,7 +90,9 @@ module UltracartClient
         :'event_new_message' => :'ConversationSummary',
         :'event_queue_position' => :'ConversationEventQueuePosition',
         :'event_queue_status_update' => :'ConversationWebchatQueueStatus',
+        :'event_rrweb' => :'ConversationEventRRWeb',
         :'event_type' => :'String',
+        :'event_typing' => :'ConversationEventTyping',
         :'event_updated_message' => :'ConversationMessage',
         :'message' => :'ConversationMessage',
         :'type' => :'String'
@@ -123,10 +131,18 @@ module UltracartClient
         self.event_queue_status_update = attributes[:'event_queue_status_update']
       end
 
+      if attributes.has_key?(:'event_rrweb')
+        self.event_rrweb = attributes[:'event_rrweb']
+      end
+
       if attributes.has_key?(:'event_type')
         self.event_type = attributes[:'event_type']
       end
 
+      if attributes.has_key?(:'event_typing')
+        self.event_typing = attributes[:'event_typing']
+      end
+
       if attributes.has_key?(:'event_updated_message')
         self.event_updated_message = attributes[:'event_updated_message']
       end
@@ -150,9 +166,9 @@ 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'])
+      event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb'])
       return false unless event_type_validator.valid?(@event_type)
-      type_validator = EnumAttributeValidator.new('String', ['message', 'event', 'ping'])
+      type_validator = EnumAttributeValidator.new('String', ['message', 'event', 'ping', 'check queue position'])
       return false unless type_validator.valid?(@type)
       true
     end
@@ -160,7 +176,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'])
+      validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb'])
       unless validator.valid?(event_type)
         fail ArgumentError, 'invalid value for "event_type", must be one of #{validator.allowable_values}.'
       end
@@ -170,7 +186,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ['message', 'event', 'ping'])
+      validator = EnumAttributeValidator.new('String', ['message', 'event', 'ping', 'check queue position'])
       unless validator.valid?(type)
         fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
       end
@@ -188,7 +204,9 @@ module UltracartClient
           event_new_message == o.event_new_message &&
           event_queue_position == o.event_queue_position &&
           event_queue_status_update == o.event_queue_status_update &&
+          event_rrweb == o.event_rrweb &&
           event_type == o.event_type &&
+          event_typing == o.event_typing &&
           event_updated_message == o.event_updated_message &&
           message == o.message &&
           type == o.type
@@ -203,7 +221,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [conversation_uuid, event_conversation_closed, event_new_conversation, event_new_message, event_queue_position, event_queue_status_update, event_type, event_updated_message, message, type].hash
+      [conversation_uuid, event_conversation_closed, event_new_conversation, event_new_message, event_queue_position, event_queue_status_update, event_rrweb, event_type, event_typing, event_updated_message, message, type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb

@@ -0,0 +1,249 @@
+=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 EmailCommseqSequenceTestRequest
+    attr_accessor :cart_id
+
+    attr_accessor :cart_item_ids
+
+    attr_accessor :esp_commseq_uuid
+
+    attr_accessor :name
+
+    attr_accessor :order_id
+
+    attr_accessor :please_review
+
+    attr_accessor :send_to_email
+
+    attr_accessor :send_to_logged_in_user
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cart_id' => :'cart_id',
+        :'cart_item_ids' => :'cart_item_ids',
+        :'esp_commseq_uuid' => :'esp_commseq_uuid',
+        :'name' => :'name',
+        :'order_id' => :'order_id',
+        :'please_review' => :'please_review',
+        :'send_to_email' => :'send_to_email',
+        :'send_to_logged_in_user' => :'send_to_logged_in_user'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cart_id' => :'String',
+        :'cart_item_ids' => :'Array<String>',
+        :'esp_commseq_uuid' => :'String',
+        :'name' => :'String',
+        :'order_id' => :'String',
+        :'please_review' => :'BOOLEAN',
+        :'send_to_email' => :'String',
+        :'send_to_logged_in_user' => :'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?(:'cart_id')
+        self.cart_id = attributes[:'cart_id']
+      end
+
+      if attributes.has_key?(:'cart_item_ids')
+        if (value = attributes[:'cart_item_ids']).is_a?(Array)
+          self.cart_item_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'esp_commseq_uuid')
+        self.esp_commseq_uuid = attributes[:'esp_commseq_uuid']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.has_key?(:'please_review')
+        self.please_review = attributes[:'please_review']
+      end
+
+      if attributes.has_key?(:'send_to_email')
+        self.send_to_email = attributes[:'send_to_email']
+      end
+
+      if attributes.has_key?(:'send_to_logged_in_user')
+        self.send_to_logged_in_user = attributes[:'send_to_logged_in_user']
+      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_id == o.cart_id &&
+          cart_item_ids == o.cart_item_ids &&
+          esp_commseq_uuid == o.esp_commseq_uuid &&
+          name == o.name &&
+          order_id == o.order_id &&
+          please_review == o.please_review &&
+          send_to_email == o.send_to_email &&
+          send_to_logged_in_user == o.send_to_logged_in_user
+    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_id, cart_item_ids, esp_commseq_uuid, name, order_id, please_review, send_to_email, send_to_logged_in_user].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