ultracart_api 4.0.137 → 4.0.139

data/lib/ultracart_api/models/order_edi_document.rb

@@ -0,0 +1,372 @@
+=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 OrderEdiDocument
+    # Direction the document flowed
+    attr_accessor :direction
+
+    # Date/time the document was created/received
+    attr_accessor :doc_dts
+
+    attr_accessor :document
+
+    attr_accessor :document_type_description
+
+    attr_accessor :document_type_number
+
+    attr_accessor :external_id
+
+    attr_accessor :functional_acknowledgement
+
+    attr_accessor :functional_acknowledgement_dts
+
+    attr_accessor :functional_acknowledgement_pending
+
+    attr_accessor :group_control_number
+
+    attr_accessor :internal_id
+
+    attr_accessor :merchant_id
+
+    attr_accessor :order_id
+
+    attr_accessor :test_mode
+
+    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
+      {
+        :'direction' => :'direction',
+        :'doc_dts' => :'doc_dts',
+        :'document' => :'document',
+        :'document_type_description' => :'document_type_description',
+        :'document_type_number' => :'document_type_number',
+        :'external_id' => :'external_id',
+        :'functional_acknowledgement' => :'functional_acknowledgement',
+        :'functional_acknowledgement_dts' => :'functional_acknowledgement_dts',
+        :'functional_acknowledgement_pending' => :'functional_acknowledgement_pending',
+        :'group_control_number' => :'group_control_number',
+        :'internal_id' => :'internal_id',
+        :'merchant_id' => :'merchant_id',
+        :'order_id' => :'order_id',
+        :'test_mode' => :'test_mode'
+      }
+    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
+      {
+        :'direction' => :'String',
+        :'doc_dts' => :'String',
+        :'document' => :'String',
+        :'document_type_description' => :'String',
+        :'document_type_number' => :'Integer',
+        :'external_id' => :'String',
+        :'functional_acknowledgement' => :'String',
+        :'functional_acknowledgement_dts' => :'String',
+        :'functional_acknowledgement_pending' => :'Boolean',
+        :'group_control_number' => :'Integer',
+        :'internal_id' => :'String',
+        :'merchant_id' => :'String',
+        :'order_id' => :'String',
+        :'test_mode' => :'Boolean'
+      }
+    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::OrderEdiDocument` 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::OrderEdiDocument`. 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?(:'direction')
+        self.direction = attributes[:'direction']
+      end
+
+      if attributes.key?(:'doc_dts')
+        self.doc_dts = attributes[:'doc_dts']
+      end
+
+      if attributes.key?(:'document')
+        self.document = attributes[:'document']
+      end
+
+      if attributes.key?(:'document_type_description')
+        self.document_type_description = attributes[:'document_type_description']
+      end
+
+      if attributes.key?(:'document_type_number')
+        self.document_type_number = attributes[:'document_type_number']
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
+      if attributes.key?(:'functional_acknowledgement')
+        self.functional_acknowledgement = attributes[:'functional_acknowledgement']
+      end
+
+      if attributes.key?(:'functional_acknowledgement_dts')
+        self.functional_acknowledgement_dts = attributes[:'functional_acknowledgement_dts']
+      end
+
+      if attributes.key?(:'functional_acknowledgement_pending')
+        self.functional_acknowledgement_pending = attributes[:'functional_acknowledgement_pending']
+      end
+
+      if attributes.key?(:'group_control_number')
+        self.group_control_number = attributes[:'group_control_number']
+      end
+
+      if attributes.key?(:'internal_id')
+        self.internal_id = attributes[:'internal_id']
+      end
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'test_mode')
+        self.test_mode = attributes[:'test_mode']
+      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?
+      direction_validator = EnumAttributeValidator.new('String', ["inbound", "outbound"])
+      return false unless direction_validator.valid?(@direction)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] direction Object to be assigned
+    def direction=(direction)
+      validator = EnumAttributeValidator.new('String', ["inbound", "outbound"])
+      unless validator.valid?(direction)
+        fail ArgumentError, "invalid value for \"direction\", must be one of #{validator.allowable_values}."
+      end
+      @direction = direction
+    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 &&
+          direction == o.direction &&
+          doc_dts == o.doc_dts &&
+          document == o.document &&
+          document_type_description == o.document_type_description &&
+          document_type_number == o.document_type_number &&
+          external_id == o.external_id &&
+          functional_acknowledgement == o.functional_acknowledgement &&
+          functional_acknowledgement_dts == o.functional_acknowledgement_dts &&
+          functional_acknowledgement_pending == o.functional_acknowledgement_pending &&
+          group_control_number == o.group_control_number &&
+          internal_id == o.internal_id &&
+          merchant_id == o.merchant_id &&
+          order_id == o.order_id &&
+          test_mode == o.test_mode
+    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
+      [direction, doc_dts, document, document_type_description, document_type_number, external_id, functional_acknowledgement, functional_acknowledgement_dts, functional_acknowledgement_pending, group_control_number, internal_id, merchant_id, order_id, test_mode].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/order_edi_documents_response.rb

@@ -0,0 +1,259 @@
+=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 OrderEdiDocumentsResponse
+    # edi_documents
+    attr_accessor :edi_documents
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'edi_documents' => :'ediDocuments',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'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
+      {
+        :'edi_documents' => :'Array<OrderEdiDocument>',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'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::OrderEdiDocumentsResponse` 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::OrderEdiDocumentsResponse`. 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?(:'edi_documents')
+        if (value = attributes[:'edi_documents']).is_a?(Array)
+          self.edi_documents = value
+        end
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      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 &&
+          edi_documents == o.edi_documents &&
+          error == o.error &&
+          metadata == o.metadata &&
+          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
+      [edi_documents, error, metadata, 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/version.rb

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

data/lib/ultracart_api.rb

@@ -186,6 +186,7 @@ require 'ultracart_api/models/conversation_permissions_response'
 require 'ultracart_api/models/conversation_response'
 require 'ultracart_api/models/conversation_search_request'
 require 'ultracart_api/models/conversation_search_response'
+require 'ultracart_api/models/conversation_sentiment'
 require 'ultracart_api/models/conversation_start_request'
 require 'ultracart_api/models/conversation_start_response'
 require 'ultracart_api/models/conversation_summary'
@@ -576,6 +577,8 @@ require 'ultracart_api/models/order_coupon'
 require 'ultracart_api/models/order_digital_item'
 require 'ultracart_api/models/order_digital_order'
 require 'ultracart_api/models/order_edi'
+require 'ultracart_api/models/order_edi_document'
+require 'ultracart_api/models/order_edi_documents_response'
 require 'ultracart_api/models/order_format'
 require 'ultracart_api/models/order_format_response'
 require 'ultracart_api/models/order_fraud_score'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.137
+  version: 4.0.139
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -236,6 +236,7 @@ files:
 - docs/ConversationResponse.md
 - docs/ConversationSearchRequest.md
 - docs/ConversationSearchResponse.md
+- docs/ConversationSentiment.md
 - docs/ConversationStartRequest.md
 - docs/ConversationStartResponse.md
 - docs/ConversationSummary.md
@@ -634,6 +635,8 @@ files:
 - docs/OrderDigitalItem.md
 - docs/OrderDigitalOrder.md
 - docs/OrderEdi.md
+- docs/OrderEdiDocument.md
+- docs/OrderEdiDocumentsResponse.md
 - docs/OrderFormat.md
 - docs/OrderFormatResponse.md
 - docs/OrderFraudScore.md
@@ -1012,6 +1015,7 @@ files:
 - lib/ultracart_api/models/conversation_response.rb
 - lib/ultracart_api/models/conversation_search_request.rb
 - lib/ultracart_api/models/conversation_search_response.rb
+- lib/ultracart_api/models/conversation_sentiment.rb
 - lib/ultracart_api/models/conversation_start_request.rb
 - lib/ultracart_api/models/conversation_start_response.rb
 - lib/ultracart_api/models/conversation_summary.rb
@@ -1402,6 +1406,8 @@ files:
 - lib/ultracart_api/models/order_digital_item.rb
 - lib/ultracart_api/models/order_digital_order.rb
 - lib/ultracart_api/models/order_edi.rb
+- lib/ultracart_api/models/order_edi_document.rb
+- lib/ultracart_api/models/order_edi_documents_response.rb
 - lib/ultracart_api/models/order_format.rb
 - lib/ultracart_api/models/order_format_response.rb
 - lib/ultracart_api/models/order_fraud_score.rb