ultracart_api 4.1.149 → 4.1.151

data/lib/ultracart_api/models/conversation_agent_test_session_response.rb

@@ -0,0 +1,285 @@
+=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 ConversationAgentTestSessionResponse
+    # Cart established for this session, soft logged in as the chosen customer profile.  Real, and anything the agent adds to it persists.
+    attr_accessor :cart_id
+
+    # Queue entry created for this session
+    attr_accessor :conversation_webchat_queue_uuid
+
+    attr_accessor :customer_auth
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Storefront the session is running against
+    attr_accessor :storefront_host_name
+
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cart_id' => :'cart_id',
+        :'conversation_webchat_queue_uuid' => :'conversation_webchat_queue_uuid',
+        :'customer_auth' => :'customer_auth',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'storefront_host_name' => :'storefront_host_name',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    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
+      {
+        :'cart_id' => :'String',
+        :'conversation_webchat_queue_uuid' => :'String',
+        :'customer_auth' => :'ConversationCustomerAuth',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'storefront_host_name' => :'String',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    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::ConversationAgentTestSessionResponse` 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::ConversationAgentTestSessionResponse`. 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?(:'cart_id')
+        self.cart_id = attributes[:'cart_id']
+      end
+
+      if attributes.key?(:'conversation_webchat_queue_uuid')
+        self.conversation_webchat_queue_uuid = attributes[:'conversation_webchat_queue_uuid']
+      end
+
+      if attributes.key?(:'customer_auth')
+        self.customer_auth = attributes[:'customer_auth']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'storefront_host_name')
+        self.storefront_host_name = attributes[:'storefront_host_name']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          conversation_webchat_queue_uuid == o.conversation_webchat_queue_uuid &&
+          customer_auth == o.customer_auth &&
+          error == o.error &&
+          metadata == o.metadata &&
+          storefront_host_name == o.storefront_host_name &&
+          success == o.success &&
+          warning == o.warning
+    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
+      [cart_id, conversation_webchat_queue_uuid, customer_auth, error, metadata, storefront_host_name, success, warning].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_customer_auth.rb

@@ -0,0 +1,273 @@
+=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 ConversationCustomerAuth
+    attr_accessor :conversation_participant_arn
+
+    attr_accessor :conversation_participant_name
+
+    attr_accessor :join_dts_conversation_participant_arn
+
+    attr_accessor :jwt
+
+    attr_accessor :merchant_id
+
+    attr_accessor :merchant_id_queue_name
+
+    attr_accessor :websocket_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'conversation_participant_arn' => :'conversation_participant_arn',
+        :'conversation_participant_name' => :'conversation_participant_name',
+        :'join_dts_conversation_participant_arn' => :'join_dts_conversation_participant_arn',
+        :'jwt' => :'jwt',
+        :'merchant_id' => :'merchant_id',
+        :'merchant_id_queue_name' => :'merchant_id_queue_name',
+        :'websocket_url' => :'websocket_url'
+      }
+    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
+      {
+        :'conversation_participant_arn' => :'String',
+        :'conversation_participant_name' => :'String',
+        :'join_dts_conversation_participant_arn' => :'String',
+        :'jwt' => :'String',
+        :'merchant_id' => :'String',
+        :'merchant_id_queue_name' => :'String',
+        :'websocket_url' => :'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::ConversationCustomerAuth` 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::ConversationCustomerAuth`. 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?(:'conversation_participant_arn')
+        self.conversation_participant_arn = attributes[:'conversation_participant_arn']
+      end
+
+      if attributes.key?(:'conversation_participant_name')
+        self.conversation_participant_name = attributes[:'conversation_participant_name']
+      end
+
+      if attributes.key?(:'join_dts_conversation_participant_arn')
+        self.join_dts_conversation_participant_arn = attributes[:'join_dts_conversation_participant_arn']
+      end
+
+      if attributes.key?(:'jwt')
+        self.jwt = attributes[:'jwt']
+      end
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'merchant_id_queue_name')
+        self.merchant_id_queue_name = attributes[:'merchant_id_queue_name']
+      end
+
+      if attributes.key?(:'websocket_url')
+        self.websocket_url = attributes[:'websocket_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 &&
+          conversation_participant_arn == o.conversation_participant_arn &&
+          conversation_participant_name == o.conversation_participant_name &&
+          join_dts_conversation_participant_arn == o.join_dts_conversation_participant_arn &&
+          jwt == o.jwt &&
+          merchant_id == o.merchant_id &&
+          merchant_id_queue_name == o.merchant_id_queue_name &&
+          websocket_url == o.websocket_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 [Integer] Hash code
+    def hash
+      [conversation_participant_arn, conversation_participant_name, join_dts_conversation_participant_arn, jwt, merchant_id, merchant_id_queue_name, websocket_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 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/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.149'
+  VERSION = '4.1.151'
 end

data/lib/ultracart_api.rb

@@ -195,6 +195,9 @@ require 'ultracart_api/models/conversation_agent_status_rollup_search_request'
 require 'ultracart_api/models/conversation_agent_status_rollup_search_response'
 require 'ultracart_api/models/conversation_agent_status_summary_response'
 require 'ultracart_api/models/conversation_agent_status_timeline_response'
+require 'ultracart_api/models/conversation_agent_test_session_join_request'
+require 'ultracart_api/models/conversation_agent_test_session_request'
+require 'ultracart_api/models/conversation_agent_test_session_response'
 require 'ultracart_api/models/conversation_autocomplete_request'
 require 'ultracart_api/models/conversation_autocomplete_response'
 require 'ultracart_api/models/conversation_autocomplete_value'
@@ -202,6 +205,7 @@ require 'ultracart_api/models/conversation_canned_message'
 require 'ultracart_api/models/conversation_canned_message_response'
 require 'ultracart_api/models/conversation_canned_messages_response'
 require 'ultracart_api/models/conversation_canned_messages_search'
+require 'ultracart_api/models/conversation_customer_auth'
 require 'ultracart_api/models/conversation_delete_knowledge_base_document_response'
 require 'ultracart_api/models/conversation_department'
 require 'ultracart_api/models/conversation_department_member'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.149
+  version: 4.1.151
 platform: ruby
 authors:
 - UltraCart
@@ -244,6 +244,9 @@ files:
 - docs/ConversationAgentStatusRollupSearchResponse.md
 - docs/ConversationAgentStatusSummaryResponse.md
 - docs/ConversationAgentStatusTimelineResponse.md
+- docs/ConversationAgentTestSessionJoinRequest.md
+- docs/ConversationAgentTestSessionRequest.md
+- docs/ConversationAgentTestSessionResponse.md
 - docs/ConversationApi.md
 - docs/ConversationAutocompleteRequest.md
 - docs/ConversationAutocompleteResponse.md
@@ -252,6 +255,7 @@ files:
 - docs/ConversationCannedMessageResponse.md
 - docs/ConversationCannedMessagesResponse.md
 - docs/ConversationCannedMessagesSearch.md
+- docs/ConversationCustomerAuth.md
 - docs/ConversationDeleteKnowledgeBaseDocumentResponse.md
 - docs/ConversationDepartment.md
 - docs/ConversationDepartmentMember.md
@@ -1382,6 +1386,9 @@ files:
 - lib/ultracart_api/models/conversation_agent_status_rollup_search_response.rb
 - lib/ultracart_api/models/conversation_agent_status_summary_response.rb
 - lib/ultracart_api/models/conversation_agent_status_timeline_response.rb
+- lib/ultracart_api/models/conversation_agent_test_session_join_request.rb
+- lib/ultracart_api/models/conversation_agent_test_session_request.rb
+- lib/ultracart_api/models/conversation_agent_test_session_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
@@ -1389,6 +1396,7 @@ files:
 - lib/ultracart_api/models/conversation_canned_message_response.rb
 - lib/ultracart_api/models/conversation_canned_messages_response.rb
 - lib/ultracart_api/models/conversation_canned_messages_search.rb
+- lib/ultracart_api/models/conversation_customer_auth.rb
 - lib/ultracart_api/models/conversation_delete_knowledge_base_document_response.rb
 - lib/ultracart_api/models/conversation_department.rb
 - lib/ultracart_api/models/conversation_department_member.rb