ultracart_api 3.10.29 → 3.10.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6abed8e1e4872a7847e7b24bf7a961f5b4327dc094b42c131548a1519bc36031
-  data.tar.gz: '0881d8766ba29f7ed66f57390336fcbf3e50368dd4de0391171ae2bf699fe2a9'
+  metadata.gz: 1dc93521a0a056bf7a1d02b2ed41c94b855d229aaf1600f015e0457c129b615f
+  data.tar.gz: 18da6c0842fb94d6bcf4ee246f7d1189e0d0b33a517afd6db652e643a90d8528
 SHA512:
-  metadata.gz: ab263cb66fcfa98b1e5bd64425baffd8202eace4d65e34eef6e680657cbaf50beb17ebf32bee8ba51778a9270a0bc3be1bc1c80aa970d2daabf90faf330ddfbe
-  data.tar.gz: 19a908d8e9aa5c372e741d8a9d380d6edf7443763696e70d8de3264e9109b041a7a04e90456b1f777a49d3b3a64d922fe07739f1d59313c49b6aae60684dbd1a
+  metadata.gz: 3acca69d44ad1edcc5659323bd9bc76edb6b97cfa0d74f41a5ea7328e605b5c91ec6a33ee60529cc931e74c159442c6b0cae515b433965d80b96bde652d251cf
+  data.tar.gz: ccbf74dc34a2823b6add1637b171a4b33e1b4b38b4b00fabe83e11e9f0cfcfc1e622e2e74e214015d28391a6615bba307434aab3b4afef454326c622d0cba929

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.29
+- Package version: 3.10.30
 - 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.29.gem
+gem install ./ultracart_api-3.10.30.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.29.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.30.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.29'
+    gem 'ultracart_api', '~> 3.10.30'
 
 ### Install from Git
 
@@ -562,6 +562,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
  - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
+ - [UltracartClient::ConversationEventRRWeb](docs/ConversationEventRRWeb.md)
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
  - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
@@ -1167,6 +1168,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.30 | 08/01/2022 | conversation event refinement |
 | 3.10.29 | 07/29/2022 | conversation development |
 | 3.10.28 | 07/28/2022 | conversation bug fixes |
 | 3.10.27 | 07/28/2022 | conversation message upload keys property |

data/docs/ConversationEventRRWeb.md

@@ -0,0 +1,14 @@
+# UltracartClient::ConversationEventRRWeb
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **String** |  | [optional] 
+**data_part** | **Integer** |  | [optional] 
+**data_sha256** | **String** |  | [optional] 
+**data_total_parts** | **Integer** |  | [optional] 
+**data_total_sha256** | **String** |  | [optional] 
+**event_index** | **Integer** |  | [optional] 
+**type** | **String** | Type of event | [optional] 
+
+

data/docs/ConversationMessage.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **media_urls** | **Array<String>** |  | [optional] 
 **message_dts** | **String** | Message date/time | [optional] 
 **transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) |  | [optional] 
+**type** | **String** | Message type | [optional] 
 **upload_keys** | **Array<String>** |  | [optional] 
 
 

data/docs/ConversationWebsocketMessage.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **event_new_message** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] 
 **event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) |  | [optional] 
 **event_queue_status_update** | [**ConversationWebchatQueueStatus**](ConversationWebchatQueueStatus.md) |  | [optional] 
+**event_rrweb** | [**ConversationEventRRWeb**](ConversationEventRRWeb.md) |  | [optional] 
 **event_type** | **String** | Type of event | [optional] 
 **event_updated_message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] 
 **message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] 

data/lib/ultracart_api/models/conversation_event_rr_web.rb

@@ -0,0 +1,273 @@
+=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 ConversationEventRRWeb
+    attr_accessor :data
+
+    attr_accessor :data_part
+
+    attr_accessor :data_sha256
+
+    attr_accessor :data_total_parts
+
+    attr_accessor :data_total_sha256
+
+    attr_accessor :event_index
+
+    # Type of event
+    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
+      {
+        :'data' => :'data',
+        :'data_part' => :'data_part',
+        :'data_sha256' => :'data_sha256',
+        :'data_total_parts' => :'data_total_parts',
+        :'data_total_sha256' => :'data_total_sha256',
+        :'event_index' => :'event_index',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'data' => :'String',
+        :'data_part' => :'Integer',
+        :'data_sha256' => :'String',
+        :'data_total_parts' => :'Integer',
+        :'data_total_sha256' => :'String',
+        :'event_index' => :'Integer',
+        :'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?(:'data')
+        self.data = attributes[:'data']
+      end
+
+      if attributes.has_key?(:'data_part')
+        self.data_part = attributes[:'data_part']
+      end
+
+      if attributes.has_key?(:'data_sha256')
+        self.data_sha256 = attributes[:'data_sha256']
+      end
+
+      if attributes.has_key?(:'data_total_parts')
+        self.data_total_parts = attributes[:'data_total_parts']
+      end
+
+      if attributes.has_key?(:'data_total_sha256')
+        self.data_total_sha256 = attributes[:'data_total_sha256']
+      end
+
+      if attributes.has_key?(:'event_index')
+        self.event_index = attributes[:'event_index']
+      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?
+      type_validator = EnumAttributeValidator.new('String', ['init', 'events'])
+      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', ['init', 'events'])
+      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 &&
+          data == o.data &&
+          data_part == o.data_part &&
+          data_sha256 == o.data_sha256 &&
+          data_total_parts == o.data_total_parts &&
+          data_total_sha256 == o.data_total_sha256 &&
+          event_index == o.event_index &&
+          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
+      [data, data_part, data_sha256, data_total_parts, data_total_sha256, event_index, 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_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,6 +27,8 @@ module UltracartClient
 
     attr_accessor :event_queue_status_update
 
+    attr_accessor :event_rrweb
+
     # Type of event
     attr_accessor :event_type
 
@@ -68,6 +70,7 @@ 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_updated_message' => :'event_updated_message',
         :'message' => :'message',
@@ -84,6 +87,7 @@ module UltracartClient
         :'event_new_message' => :'ConversationSummary',
         :'event_queue_position' => :'ConversationEventQueuePosition',
         :'event_queue_status_update' => :'ConversationWebchatQueueStatus',
+        :'event_rrweb' => :'ConversationEventRRWeb',
         :'event_type' => :'String',
         :'event_updated_message' => :'ConversationMessage',
         :'message' => :'ConversationMessage',
@@ -123,6 +127,10 @@ 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
@@ -150,9 +158,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 +168,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 +178,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,6 +196,7 @@ 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_updated_message == o.event_updated_message &&
           message == o.message &&
@@ -203,7 +212,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_updated_message, message, type].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.29'
+  VERSION = '3.10.30'
 end

data/lib/ultracart_api.rb

@@ -138,6 +138,7 @@ require 'ultracart_api/models/conversation'
 require 'ultracart_api/models/conversation_agent_auth'
 require 'ultracart_api/models/conversation_agent_auth_response'
 require 'ultracart_api/models/conversation_event_queue_position'
+require 'ultracart_api/models/conversation_event_rr_web'
 require 'ultracart_api/models/conversation_message'
 require 'ultracart_api/models/conversation_message_transport_status'
 require 'ultracart_api/models/conversation_multimedia_upload_url'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.29
+  version: 3.10.30
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -348,6 +348,7 @@ files:
 - docs/ConversationAgentAuthResponse.md
 - docs/ConversationApi.md
 - docs/ConversationEventQueuePosition.md
+- docs/ConversationEventRRWeb.md
 - docs/ConversationMessage.md
 - docs/ConversationMessageTransportStatus.md
 - docs/ConversationMultimediaUploadUrl.md
@@ -1041,6 +1042,7 @@ files:
 - lib/ultracart_api/models/conversation_agent_auth.rb
 - lib/ultracart_api/models/conversation_agent_auth_response.rb
 - lib/ultracart_api/models/conversation_event_queue_position.rb
+- lib/ultracart_api/models/conversation_event_rr_web.rb
 - lib/ultracart_api/models/conversation_message.rb
 - lib/ultracart_api/models/conversation_message_transport_status.rb
 - lib/ultracart_api/models/conversation_multimedia_upload_url.rb