ultracart_api 3.4.7 → 3.4.11

data/lib/ultracart_api/models/payments_configuration_cod.rb

@@ -14,27 +14,32 @@ require 'date'
 
 module UltracartClient
   class PaymentsConfigurationCOD
+    # Master flag indicating this merchant accepts COD
     attr_accessor :accept_cod
 
-    attr_accessor :cod_approved_customers_only
+    # If true, only approved customers may pay with COD
+    attr_accessor :approved_customers_only
 
-    attr_accessor :cod_surcharge_accounting_code
+    attr_accessor :restrictions
 
-    attr_accessor :cod_surcharge_fee
+    # Optional field, if surcharge is set, this is the accounting code the surcharge is tagged with when sent to Quickbooks
+    attr_accessor :surcharge_accounting_code
 
-    attr_accessor :cod_surcharge_perc
+    # Additional cost for using COD
+    attr_accessor :surcharge_fee
 
-    attr_accessor :restrictions
+    # Additional percentage cost for using COD
+    attr_accessor :surcharge_percentage
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'accept_cod' => :'acceptCod',
-        :'cod_approved_customers_only' => :'codApprovedCustomersOnly',
-        :'cod_surcharge_accounting_code' => :'codSurchargeAccountingCode',
-        :'cod_surcharge_fee' => :'codSurchargeFee',
-        :'cod_surcharge_perc' => :'codSurchargePerc',
-        :'restrictions' => :'restrictions'
+        :'accept_cod' => :'accept_cod',
+        :'approved_customers_only' => :'approved_customers_only',
+        :'restrictions' => :'restrictions',
+        :'surcharge_accounting_code' => :'surcharge_accounting_code',
+        :'surcharge_fee' => :'surcharge_fee',
+        :'surcharge_percentage' => :'surcharge_percentage'
       }
     end
 
@@ -42,11 +47,11 @@ module UltracartClient
     def self.swagger_types
       {
         :'accept_cod' => :'BOOLEAN',
-        :'cod_approved_customers_only' => :'BOOLEAN',
-        :'cod_surcharge_accounting_code' => :'String',
-        :'cod_surcharge_fee' => :'String',
-        :'cod_surcharge_perc' => :'String',
-        :'restrictions' => :'PaymentsConfigurationRestrictions'
+        :'approved_customers_only' => :'BOOLEAN',
+        :'restrictions' => :'PaymentsConfigurationRestrictions',
+        :'surcharge_accounting_code' => :'String',
+        :'surcharge_fee' => :'String',
+        :'surcharge_percentage' => :'String'
       }
     end
 
@@ -58,28 +63,28 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'acceptCod')
-        self.accept_cod = attributes[:'acceptCod']
+      if attributes.has_key?(:'accept_cod')
+        self.accept_cod = attributes[:'accept_cod']
       end
 
-      if attributes.has_key?(:'codApprovedCustomersOnly')
-        self.cod_approved_customers_only = attributes[:'codApprovedCustomersOnly']
+      if attributes.has_key?(:'approved_customers_only')
+        self.approved_customers_only = attributes[:'approved_customers_only']
       end
 
-      if attributes.has_key?(:'codSurchargeAccountingCode')
-        self.cod_surcharge_accounting_code = attributes[:'codSurchargeAccountingCode']
+      if attributes.has_key?(:'restrictions')
+        self.restrictions = attributes[:'restrictions']
       end
 
-      if attributes.has_key?(:'codSurchargeFee')
-        self.cod_surcharge_fee = attributes[:'codSurchargeFee']
+      if attributes.has_key?(:'surcharge_accounting_code')
+        self.surcharge_accounting_code = attributes[:'surcharge_accounting_code']
       end
 
-      if attributes.has_key?(:'codSurchargePerc')
-        self.cod_surcharge_perc = attributes[:'codSurchargePerc']
+      if attributes.has_key?(:'surcharge_fee')
+        self.surcharge_fee = attributes[:'surcharge_fee']
       end
 
-      if attributes.has_key?(:'restrictions')
-        self.restrictions = attributes[:'restrictions']
+      if attributes.has_key?(:'surcharge_percentage')
+        self.surcharge_percentage = attributes[:'surcharge_percentage']
       end
     end
 
@@ -102,11 +107,11 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           accept_cod == o.accept_cod &&
-          cod_approved_customers_only == o.cod_approved_customers_only &&
-          cod_surcharge_accounting_code == o.cod_surcharge_accounting_code &&
-          cod_surcharge_fee == o.cod_surcharge_fee &&
-          cod_surcharge_perc == o.cod_surcharge_perc &&
-          restrictions == o.restrictions
+          approved_customers_only == o.approved_customers_only &&
+          restrictions == o.restrictions &&
+          surcharge_accounting_code == o.surcharge_accounting_code &&
+          surcharge_fee == o.surcharge_fee &&
+          surcharge_percentage == o.surcharge_percentage
     end
 
     # @see the `==` method
@@ -118,7 +123,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accept_cod, cod_approved_customers_only, cod_surcharge_accounting_code, cod_surcharge_fee, cod_surcharge_perc, restrictions].hash
+      [accept_cod, approved_customers_only, restrictions, surcharge_accounting_code, surcharge_fee, surcharge_percentage].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/payments_configuration_credit_card.rb

@@ -14,47 +14,70 @@ require 'date'
 
 module UltracartClient
   class PaymentsConfigurationCreditCard
-    attr_accessor :accept_credit_cards
+    # Master flag indicating whether this merchant accepts credit card payments
+    attr_accessor :accept_credit_card
 
+    # Description that appears on customer statements
     attr_accessor :billed_by
 
+    # If false, order will be accepted and placed into Accounts Receivable without charging card first
     attr_accessor :charge_during_checkout
 
+    # UltraCart will require customer to enter cvv if this is true
     attr_accessor :collect_cvv2
 
-    attr_accessor :configured_gateways_details
+    # Human readable description of the credit card gateway currently configured
+    attr_accessor :configured_gateway_details
 
+    # The number of failed attempts before the order is placed into Accounts Receivable for manual intervention
     attr_accessor :failed_attempts
 
+    # This internal flag aids the UI in determining which buttons to show.
     attr_accessor :hide_connect_single_gateway
 
+    # Restrictions for this payment method
+    attr_accessor :restrictions
+
+    # UltraCart will send customers emails to update their credit card if the card is declined
     attr_accessor :send_customer_billing_update_on_decline
 
+    # A list of credit cards the merchant wishes to accept.
+    attr_accessor :supported_cards
+
+    # An array of test methods for placing test orders.  The cards defined here may be real or fake, but any order placed with them will be marked as Test orders
+    attr_accessor :test_methods
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'accept_credit_cards' => :'acceptCreditCards',
-        :'billed_by' => :'billedBy',
-        :'charge_during_checkout' => :'chargeDuringCheckout',
-        :'collect_cvv2' => :'collectCvv2',
-        :'configured_gateways_details' => :'configuredGatewaysDetails',
-        :'failed_attempts' => :'failedAttempts',
-        :'hide_connect_single_gateway' => :'hideConnectSingleGateway',
-        :'send_customer_billing_update_on_decline' => :'sendCustomerBillingUpdateOnDecline'
+        :'accept_credit_card' => :'accept_credit_card',
+        :'billed_by' => :'billed_by',
+        :'charge_during_checkout' => :'charge_during_checkout',
+        :'collect_cvv2' => :'collect_cvv2',
+        :'configured_gateway_details' => :'configured_gateway_details',
+        :'failed_attempts' => :'failed_attempts',
+        :'hide_connect_single_gateway' => :'hide_connect_single_gateway',
+        :'restrictions' => :'restrictions',
+        :'send_customer_billing_update_on_decline' => :'send_customer_billing_update_on_decline',
+        :'supported_cards' => :'supported_cards',
+        :'test_methods' => :'test_methods'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'accept_credit_cards' => :'BOOLEAN',
+        :'accept_credit_card' => :'BOOLEAN',
         :'billed_by' => :'String',
         :'charge_during_checkout' => :'BOOLEAN',
         :'collect_cvv2' => :'BOOLEAN',
-        :'configured_gateways_details' => :'String',
-        :'failed_attempts' => :'String',
+        :'configured_gateway_details' => :'String',
+        :'failed_attempts' => :'Integer',
         :'hide_connect_single_gateway' => :'BOOLEAN',
-        :'send_customer_billing_update_on_decline' => :'BOOLEAN'
+        :'restrictions' => :'Array<PaymentsConfigurationRestrictions>',
+        :'send_customer_billing_update_on_decline' => :'BOOLEAN',
+        :'supported_cards' => :'Array<PaymentsConfigurationCreditCardType>',
+        :'test_methods' => :'Array<PaymentsConfigurationTestMethod>'
       }
     end
 
@@ -66,36 +89,54 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'acceptCreditCards')
-        self.accept_credit_cards = attributes[:'acceptCreditCards']
+      if attributes.has_key?(:'accept_credit_card')
+        self.accept_credit_card = attributes[:'accept_credit_card']
+      end
+
+      if attributes.has_key?(:'billed_by')
+        self.billed_by = attributes[:'billed_by']
+      end
+
+      if attributes.has_key?(:'charge_during_checkout')
+        self.charge_during_checkout = attributes[:'charge_during_checkout']
+      end
+
+      if attributes.has_key?(:'collect_cvv2')
+        self.collect_cvv2 = attributes[:'collect_cvv2']
       end
 
-      if attributes.has_key?(:'billedBy')
-        self.billed_by = attributes[:'billedBy']
+      if attributes.has_key?(:'configured_gateway_details')
+        self.configured_gateway_details = attributes[:'configured_gateway_details']
       end
 
-      if attributes.has_key?(:'chargeDuringCheckout')
-        self.charge_during_checkout = attributes[:'chargeDuringCheckout']
+      if attributes.has_key?(:'failed_attempts')
+        self.failed_attempts = attributes[:'failed_attempts']
       end
 
-      if attributes.has_key?(:'collectCvv2')
-        self.collect_cvv2 = attributes[:'collectCvv2']
+      if attributes.has_key?(:'hide_connect_single_gateway')
+        self.hide_connect_single_gateway = attributes[:'hide_connect_single_gateway']
       end
 
-      if attributes.has_key?(:'configuredGatewaysDetails')
-        self.configured_gateways_details = attributes[:'configuredGatewaysDetails']
+      if attributes.has_key?(:'restrictions')
+        if (value = attributes[:'restrictions']).is_a?(Array)
+          self.restrictions = value
+        end
       end
 
-      if attributes.has_key?(:'failedAttempts')
-        self.failed_attempts = attributes[:'failedAttempts']
+      if attributes.has_key?(:'send_customer_billing_update_on_decline')
+        self.send_customer_billing_update_on_decline = attributes[:'send_customer_billing_update_on_decline']
       end
 
-      if attributes.has_key?(:'hideConnectSingleGateway')
-        self.hide_connect_single_gateway = attributes[:'hideConnectSingleGateway']
+      if attributes.has_key?(:'supported_cards')
+        if (value = attributes[:'supported_cards']).is_a?(Array)
+          self.supported_cards = value
+        end
       end
 
-      if attributes.has_key?(:'sendCustomerBillingUpdateOnDecline')
-        self.send_customer_billing_update_on_decline = attributes[:'sendCustomerBillingUpdateOnDecline']
+      if attributes.has_key?(:'test_methods')
+        if (value = attributes[:'test_methods']).is_a?(Array)
+          self.test_methods = value
+        end
       end
     end
 
@@ -117,14 +158,17 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          accept_credit_cards == o.accept_credit_cards &&
+          accept_credit_card == o.accept_credit_card &&
           billed_by == o.billed_by &&
           charge_during_checkout == o.charge_during_checkout &&
           collect_cvv2 == o.collect_cvv2 &&
-          configured_gateways_details == o.configured_gateways_details &&
+          configured_gateway_details == o.configured_gateway_details &&
           failed_attempts == o.failed_attempts &&
           hide_connect_single_gateway == o.hide_connect_single_gateway &&
-          send_customer_billing_update_on_decline == o.send_customer_billing_update_on_decline
+          restrictions == o.restrictions &&
+          send_customer_billing_update_on_decline == o.send_customer_billing_update_on_decline &&
+          supported_cards == o.supported_cards &&
+          test_methods == o.test_methods
     end
 
     # @see the `==` method
@@ -136,7 +180,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accept_credit_cards, billed_by, charge_during_checkout, collect_cvv2, configured_gateways_details, failed_attempts, hide_connect_single_gateway, send_customer_billing_update_on_decline].hash
+      [accept_credit_card, billed_by, charge_during_checkout, collect_cvv2, configured_gateway_details, failed_attempts, hide_connect_single_gateway, restrictions, send_customer_billing_update_on_decline, supported_cards, test_methods].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/payments_configuration_credit_card_type.rb

@@ -0,0 +1,309 @@
+=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 PaymentsConfigurationCreditCardType
+    # Optional field used for Quickbooks integrations to match this credit card with the corresponding payment type in Quickbooks
+    attr_accessor :accounting_code
+
+    # Internally used icon information for this card type
+    attr_accessor :card_type_icon
+
+    # Credit card type
+    attr_accessor :credit_card
+
+    # The name of the account to deposit funds
+    attr_accessor :deposit_to_account
+
+    # If true, this card type will be accepted during checkout
+    attr_accessor :enabled
+
+    # Optional additional fee applied to order for this card
+    attr_accessor :processing_fee
+
+    # Optional additional fee applied to order for this card
+    attr_accessor :processing_percentage
+
+    # Optional field. If integrated with Quickbooks, this code will be used when informing Quickbooks about any surcharges applied to orders
+    attr_accessor :surcharge_accounting_code
+
+    # An optional additional fee to charge the customer for using this card.
+    attr_accessor :transaction_fee
+
+    # An optional transaction percentage to charge the customer for using this card
+    attr_accessor :transaction_percentage
+
+    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
+      {
+        :'accounting_code' => :'accounting_code',
+        :'card_type_icon' => :'card_type_icon',
+        :'credit_card' => :'credit_card',
+        :'deposit_to_account' => :'deposit_to_account',
+        :'enabled' => :'enabled',
+        :'processing_fee' => :'processing_fee',
+        :'processing_percentage' => :'processing_percentage',
+        :'surcharge_accounting_code' => :'surcharge_accounting_code',
+        :'transaction_fee' => :'transaction_fee',
+        :'transaction_percentage' => :'transaction_percentage'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'accounting_code' => :'String',
+        :'card_type_icon' => :'String',
+        :'credit_card' => :'String',
+        :'deposit_to_account' => :'String',
+        :'enabled' => :'BOOLEAN',
+        :'processing_fee' => :'String',
+        :'processing_percentage' => :'String',
+        :'surcharge_accounting_code' => :'String',
+        :'transaction_fee' => :'String',
+        :'transaction_percentage' => :'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?(:'accounting_code')
+        self.accounting_code = attributes[:'accounting_code']
+      end
+
+      if attributes.has_key?(:'card_type_icon')
+        self.card_type_icon = attributes[:'card_type_icon']
+      end
+
+      if attributes.has_key?(:'credit_card')
+        self.credit_card = attributes[:'credit_card']
+      end
+
+      if attributes.has_key?(:'deposit_to_account')
+        self.deposit_to_account = attributes[:'deposit_to_account']
+      end
+
+      if attributes.has_key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.has_key?(:'processing_fee')
+        self.processing_fee = attributes[:'processing_fee']
+      end
+
+      if attributes.has_key?(:'processing_percentage')
+        self.processing_percentage = attributes[:'processing_percentage']
+      end
+
+      if attributes.has_key?(:'surcharge_accounting_code')
+        self.surcharge_accounting_code = attributes[:'surcharge_accounting_code']
+      end
+
+      if attributes.has_key?(:'transaction_fee')
+        self.transaction_fee = attributes[:'transaction_fee']
+      end
+
+      if attributes.has_key?(:'transaction_percentage')
+        self.transaction_percentage = attributes[:'transaction_percentage']
+      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?
+      credit_card_validator = EnumAttributeValidator.new('String', ['AMEX', 'Visa', 'Diners Club', 'Discover', 'JCB', 'MasterCard'])
+      return false unless credit_card_validator.valid?(@credit_card)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] credit_card Object to be assigned
+    def credit_card=(credit_card)
+      validator = EnumAttributeValidator.new('String', ['AMEX', 'Visa', 'Diners Club', 'Discover', 'JCB', 'MasterCard'])
+      unless validator.valid?(credit_card)
+        fail ArgumentError, 'invalid value for "credit_card", must be one of #{validator.allowable_values}.'
+      end
+      @credit_card = credit_card
+    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 &&
+          accounting_code == o.accounting_code &&
+          card_type_icon == o.card_type_icon &&
+          credit_card == o.credit_card &&
+          deposit_to_account == o.deposit_to_account &&
+          enabled == o.enabled &&
+          processing_fee == o.processing_fee &&
+          processing_percentage == o.processing_percentage &&
+          surcharge_accounting_code == o.surcharge_accounting_code &&
+          transaction_fee == o.transaction_fee &&
+          transaction_percentage == o.transaction_percentage
+    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
+      [accounting_code, card_type_icon, credit_card, deposit_to_account, enabled, processing_fee, processing_percentage, surcharge_accounting_code, transaction_fee, transaction_percentage].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