ultracart_api 3.10.164 → 3.10.166

data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb

@@ -0,0 +1,235 @@
+=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 CartPaymentHealthBenefitCard
+    # Health benefit expiration month (1-12)
+    attr_accessor :health_benefit_card_expiration_month
+
+    # Health benefit card expiration year (four digit year)
+    attr_accessor :health_benefit_card_expiration_year
+
+    # Health benefit card number (masked to the last 4)
+    attr_accessor :health_benefit_card_number
+
+    # Hosted field token for the card number
+    attr_accessor :health_benefit_card_number_token
+
+    # Health benefit card verification number (masked)
+    attr_accessor :health_benefit_card_verification_number
+
+    # Hosted field token for the health benefit card verification number
+    attr_accessor :health_benefit_card_verification_number_token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'health_benefit_card_expiration_month' => :'health_benefit_card_expiration_month',
+        :'health_benefit_card_expiration_year' => :'health_benefit_card_expiration_year',
+        :'health_benefit_card_number' => :'health_benefit_card_number',
+        :'health_benefit_card_number_token' => :'health_benefit_card_number_token',
+        :'health_benefit_card_verification_number' => :'health_benefit_card_verification_number',
+        :'health_benefit_card_verification_number_token' => :'health_benefit_card_verification_number_token'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'health_benefit_card_expiration_month' => :'Integer',
+        :'health_benefit_card_expiration_year' => :'Integer',
+        :'health_benefit_card_number' => :'String',
+        :'health_benefit_card_number_token' => :'String',
+        :'health_benefit_card_verification_number' => :'String',
+        :'health_benefit_card_verification_number_token' => :'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?(:'health_benefit_card_expiration_month')
+        self.health_benefit_card_expiration_month = attributes[:'health_benefit_card_expiration_month']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_expiration_year')
+        self.health_benefit_card_expiration_year = attributes[:'health_benefit_card_expiration_year']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_number')
+        self.health_benefit_card_number = attributes[:'health_benefit_card_number']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_number_token')
+        self.health_benefit_card_number_token = attributes[:'health_benefit_card_number_token']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_verification_number')
+        self.health_benefit_card_verification_number = attributes[:'health_benefit_card_verification_number']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_verification_number_token')
+        self.health_benefit_card_verification_number_token = attributes[:'health_benefit_card_verification_number_token']
+      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 &&
+          health_benefit_card_expiration_month == o.health_benefit_card_expiration_month &&
+          health_benefit_card_expiration_year == o.health_benefit_card_expiration_year &&
+          health_benefit_card_number == o.health_benefit_card_number &&
+          health_benefit_card_number_token == o.health_benefit_card_number_token &&
+          health_benefit_card_verification_number == o.health_benefit_card_verification_number &&
+          health_benefit_card_verification_number_token == o.health_benefit_card_verification_number_token
+    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
+      [health_benefit_card_expiration_month, health_benefit_card_expiration_year, health_benefit_card_number, health_benefit_card_number_token, health_benefit_card_verification_number, health_benefit_card_verification_number_token].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/order_payment.rb

@@ -20,6 +20,8 @@ module UltracartClient
 
     attr_accessor :echeck
 
+    attr_accessor :health_benefit_card
+
     # True if order has been held for fraud review
     attr_accessor :hold_for_fraud_review
 
@@ -90,6 +92,7 @@ module UltracartClient
         :'check' => :'check',
         :'credit_card' => :'credit_card',
         :'echeck' => :'echeck',
+        :'health_benefit_card' => :'health_benefit_card',
         :'hold_for_fraud_review' => :'hold_for_fraud_review',
         :'insurance' => :'insurance',
         :'payment_dts' => :'payment_dts',
@@ -114,6 +117,7 @@ module UltracartClient
         :'check' => :'OrderPaymentCheck',
         :'credit_card' => :'OrderPaymentCreditCard',
         :'echeck' => :'OrderPaymentECheck',
+        :'health_benefit_card' => :'OrderPaymentHealthBenefitCard',
         :'hold_for_fraud_review' => :'BOOLEAN',
         :'insurance' => :'OrderPaymentInsurance',
         :'payment_dts' => :'String',
@@ -152,6 +156,10 @@ module UltracartClient
         self.echeck = attributes[:'echeck']
       end
 
+      if attributes.has_key?(:'health_benefit_card')
+        self.health_benefit_card = attributes[:'health_benefit_card']
+      end
+
       if attributes.has_key?(:'hold_for_fraud_review')
         self.hold_for_fraud_review = attributes[:'hold_for_fraud_review']
       end
@@ -225,7 +233,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?
-      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Insurance', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay'])
+      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Insurance', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card'])
       return false unless payment_method_validator.valid?(@payment_method)
       payment_status_validator = EnumAttributeValidator.new('String', ['Unprocessed', 'Authorized', 'Capture Failed', 'Processed', 'Declined', 'Voided', 'Refunded', 'Skipped'])
       return false unless payment_status_validator.valid?(@payment_status)
@@ -235,7 +243,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_method Object to be assigned
     def payment_method=(payment_method)
-      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Insurance', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay'])
+      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Insurance', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card'])
       unless validator.valid?(payment_method)
         fail ArgumentError, 'invalid value for "payment_method", must be one of #{validator.allowable_values}.'
       end
@@ -260,6 +268,7 @@ module UltracartClient
           check == o.check &&
           credit_card == o.credit_card &&
           echeck == o.echeck &&
+          health_benefit_card == o.health_benefit_card &&
           hold_for_fraud_review == o.hold_for_fraud_review &&
           insurance == o.insurance &&
           payment_dts == o.payment_dts &&
@@ -286,7 +295,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [check, credit_card, echeck, hold_for_fraud_review, insurance, payment_dts, payment_method, payment_method_accounting_code, payment_method_deposit_to_account, payment_status, purchase_order, rotating_transaction_gateway_code, surcharge, surcharge_accounting_code, surcharge_transaction_fee, surcharge_transaction_percentage, test_order, transactions].hash
+      [check, credit_card, echeck, health_benefit_card, hold_for_fraud_review, insurance, payment_dts, payment_method, payment_method_accounting_code, payment_method_deposit_to_account, payment_status, purchase_order, rotating_transaction_gateway_code, surcharge, surcharge_accounting_code, surcharge_transaction_fee, surcharge_transaction_percentage, test_order, transactions].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_payment_health_benefit_card.rb

@@ -0,0 +1,235 @@
+=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 OrderPaymentHealthBenefitCard
+    # Health benefit card expiration month (1-12)
+    attr_accessor :health_benefit_card_expiration_month
+
+    # Health benefit card expiration year (Four digit year)
+    attr_accessor :health_benefit_card_expiration_year
+
+    # Health benefit card number (masked to last 4)
+    attr_accessor :health_benefit_card_number
+
+    # Health benefit card number token from hosted fields used to update the health benefit card number
+    attr_accessor :health_benefit_card_number_token
+
+    # True if the health benefit card has been truncated
+    attr_accessor :health_benefit_card_number_truncated
+
+    # Health benefit card verification number token from hosted fields, only for import/insert of new orders, completely ignored for updates, and always null/empty for queries
+    attr_accessor :health_benefit_card_verification_number_token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'health_benefit_card_expiration_month' => :'health_benefit_card_expiration_month',
+        :'health_benefit_card_expiration_year' => :'health_benefit_card_expiration_year',
+        :'health_benefit_card_number' => :'health_benefit_card_number',
+        :'health_benefit_card_number_token' => :'health_benefit_card_number_token',
+        :'health_benefit_card_number_truncated' => :'health_benefit_card_number_truncated',
+        :'health_benefit_card_verification_number_token' => :'health_benefit_card_verification_number_token'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'health_benefit_card_expiration_month' => :'Integer',
+        :'health_benefit_card_expiration_year' => :'Integer',
+        :'health_benefit_card_number' => :'String',
+        :'health_benefit_card_number_token' => :'String',
+        :'health_benefit_card_number_truncated' => :'BOOLEAN',
+        :'health_benefit_card_verification_number_token' => :'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?(:'health_benefit_card_expiration_month')
+        self.health_benefit_card_expiration_month = attributes[:'health_benefit_card_expiration_month']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_expiration_year')
+        self.health_benefit_card_expiration_year = attributes[:'health_benefit_card_expiration_year']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_number')
+        self.health_benefit_card_number = attributes[:'health_benefit_card_number']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_number_token')
+        self.health_benefit_card_number_token = attributes[:'health_benefit_card_number_token']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_number_truncated')
+        self.health_benefit_card_number_truncated = attributes[:'health_benefit_card_number_truncated']
+      end
+
+      if attributes.has_key?(:'health_benefit_card_verification_number_token')
+        self.health_benefit_card_verification_number_token = attributes[:'health_benefit_card_verification_number_token']
+      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 &&
+          health_benefit_card_expiration_month == o.health_benefit_card_expiration_month &&
+          health_benefit_card_expiration_year == o.health_benefit_card_expiration_year &&
+          health_benefit_card_number == o.health_benefit_card_number &&
+          health_benefit_card_number_token == o.health_benefit_card_number_token &&
+          health_benefit_card_number_truncated == o.health_benefit_card_number_truncated &&
+          health_benefit_card_verification_number_token == o.health_benefit_card_verification_number_token
+    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
+      [health_benefit_card_expiration_month, health_benefit_card_expiration_year, health_benefit_card_number, health_benefit_card_number_token, health_benefit_card_number_truncated, health_benefit_card_verification_number_token].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