ultracart_api 3.4.8 → 3.4.12

data/lib/ultracart_api/models/payments_configuration_cash.rb

@@ -14,6 +14,7 @@ require 'date'
 
 module UltracartClient
   class PaymentsConfigurationCash
+    # Master flag indicating this merchant accepts cash
     attr_accessor :accept_cash
 
     attr_accessor :restrictions
@@ -21,7 +22,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'accept_cash' => :'acceptCash',
+        :'accept_cash' => :'accept_cash',
         :'restrictions' => :'restrictions'
       }
     end
@@ -42,8 +43,8 @@ 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?(:'acceptCash')
-        self.accept_cash = attributes[:'acceptCash']
+      if attributes.has_key?(:'accept_cash')
+        self.accept_cash = attributes[:'accept_cash']
       end
 
       if attributes.has_key?(:'restrictions')

data/lib/ultracart_api/models/payments_configuration_check.rb

@@ -14,51 +14,60 @@ require 'date'
 
 module UltracartClient
   class PaymentsConfigurationCheck
+    # Master flag indicating this merchant accepts paper checks
     attr_accessor :accept_check_orders
 
-    attr_accessor :check_accounting_code
-
-    attr_accessor :check_deposit_to_account
+    # Optional Quickbooks accounting code
+    attr_accessor :accounting_code
 
+    # This is who the customer makes the check out to
     attr_accessor :checks_payable_to
 
+    # Optional Quickbooks deposit to account
+    attr_accessor :deposit_to_account
+
+    # MailTo address line 1
     attr_accessor :mail_to_address1
 
+    # MailTo address line 2
     attr_accessor :mail_to_address2
 
+    # MailTo city
     attr_accessor :mail_to_city
 
+    # MailTo country
     attr_accessor :mail_to_country
 
+    # MailTo name
     attr_accessor :mail_to_name
 
-    attr_accessor :mail_to_state
-
-    attr_accessor :mail_to_zip
+    # MailTo postal code
+    attr_accessor :mail_to_postal_code
 
-    attr_accessor :money_order_accounting_code
-
-    attr_accessor :money_order_deposit_to_account
+    # MailTo store
+    attr_accessor :mail_to_store
 
     attr_accessor :restrictions
 
+    # Test methods for this payment method
+    attr_accessor :test_methods
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'accept_check_orders' => :'acceptCheckOrders',
-        :'check_accounting_code' => :'checkAccountingCode',
-        :'check_deposit_to_account' => :'checkDepositToAccount',
-        :'checks_payable_to' => :'checksPayableTo',
-        :'mail_to_address1' => :'mailToAddress1',
-        :'mail_to_address2' => :'mailToAddress2',
-        :'mail_to_city' => :'mailToCity',
-        :'mail_to_country' => :'mailToCountry',
-        :'mail_to_name' => :'mailToName',
-        :'mail_to_state' => :'mailToState',
-        :'mail_to_zip' => :'mailToZip',
-        :'money_order_accounting_code' => :'moneyOrderAccountingCode',
-        :'money_order_deposit_to_account' => :'moneyOrderDepositToAccount',
-        :'restrictions' => :'restrictions'
+        :'accept_check_orders' => :'accept_check_orders',
+        :'accounting_code' => :'accounting_code',
+        :'checks_payable_to' => :'checks_payable_to',
+        :'deposit_to_account' => :'deposit_to_account',
+        :'mail_to_address1' => :'mail_to_address1',
+        :'mail_to_address2' => :'mail_to_address2',
+        :'mail_to_city' => :'mail_to_city',
+        :'mail_to_country' => :'mail_to_country',
+        :'mail_to_name' => :'mail_to_name',
+        :'mail_to_postal_code' => :'mail_to_postal_code',
+        :'mail_to_store' => :'mail_to_store',
+        :'restrictions' => :'restrictions',
+        :'test_methods' => :'test_methods'
       }
     end
 
@@ -66,19 +75,18 @@ module UltracartClient
     def self.swagger_types
       {
         :'accept_check_orders' => :'BOOLEAN',
-        :'check_accounting_code' => :'String',
-        :'check_deposit_to_account' => :'String',
+        :'accounting_code' => :'String',
         :'checks_payable_to' => :'String',
+        :'deposit_to_account' => :'String',
         :'mail_to_address1' => :'String',
         :'mail_to_address2' => :'String',
         :'mail_to_city' => :'String',
         :'mail_to_country' => :'String',
         :'mail_to_name' => :'String',
-        :'mail_to_state' => :'String',
-        :'mail_to_zip' => :'String',
-        :'money_order_accounting_code' => :'String',
-        :'money_order_deposit_to_account' => :'String',
-        :'restrictions' => :'PaymentsConfigurationRestrictions'
+        :'mail_to_postal_code' => :'String',
+        :'mail_to_store' => :'String',
+        :'restrictions' => :'PaymentsConfigurationRestrictions',
+        :'test_methods' => :'Array<PaymentsConfigurationTestMethod>'
       }
     end
 
@@ -90,61 +98,59 @@ 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?(:'acceptCheckOrders')
-        self.accept_check_orders = attributes[:'acceptCheckOrders']
-      end
-
-      if attributes.has_key?(:'checkAccountingCode')
-        self.check_accounting_code = attributes[:'checkAccountingCode']
-      end
-
-      if attributes.has_key?(:'checkDepositToAccount')
-        self.check_deposit_to_account = attributes[:'checkDepositToAccount']
+      if attributes.has_key?(:'accept_check_orders')
+        self.accept_check_orders = attributes[:'accept_check_orders']
       end
 
-      if attributes.has_key?(:'checksPayableTo')
-        self.checks_payable_to = attributes[:'checksPayableTo']
+      if attributes.has_key?(:'accounting_code')
+        self.accounting_code = attributes[:'accounting_code']
       end
 
-      if attributes.has_key?(:'mailToAddress1')
-        self.mail_to_address1 = attributes[:'mailToAddress1']
+      if attributes.has_key?(:'checks_payable_to')
+        self.checks_payable_to = attributes[:'checks_payable_to']
       end
 
-      if attributes.has_key?(:'mailToAddress2')
-        self.mail_to_address2 = attributes[:'mailToAddress2']
+      if attributes.has_key?(:'deposit_to_account')
+        self.deposit_to_account = attributes[:'deposit_to_account']
       end
 
-      if attributes.has_key?(:'mailToCity')
-        self.mail_to_city = attributes[:'mailToCity']
+      if attributes.has_key?(:'mail_to_address1')
+        self.mail_to_address1 = attributes[:'mail_to_address1']
       end
 
-      if attributes.has_key?(:'mailToCountry')
-        self.mail_to_country = attributes[:'mailToCountry']
+      if attributes.has_key?(:'mail_to_address2')
+        self.mail_to_address2 = attributes[:'mail_to_address2']
       end
 
-      if attributes.has_key?(:'mailToName')
-        self.mail_to_name = attributes[:'mailToName']
+      if attributes.has_key?(:'mail_to_city')
+        self.mail_to_city = attributes[:'mail_to_city']
       end
 
-      if attributes.has_key?(:'mailToState')
-        self.mail_to_state = attributes[:'mailToState']
+      if attributes.has_key?(:'mail_to_country')
+        self.mail_to_country = attributes[:'mail_to_country']
       end
 
-      if attributes.has_key?(:'mailToZip')
-        self.mail_to_zip = attributes[:'mailToZip']
+      if attributes.has_key?(:'mail_to_name')
+        self.mail_to_name = attributes[:'mail_to_name']
       end
 
-      if attributes.has_key?(:'moneyOrderAccountingCode')
-        self.money_order_accounting_code = attributes[:'moneyOrderAccountingCode']
+      if attributes.has_key?(:'mail_to_postal_code')
+        self.mail_to_postal_code = attributes[:'mail_to_postal_code']
       end
 
-      if attributes.has_key?(:'moneyOrderDepositToAccount')
-        self.money_order_deposit_to_account = attributes[:'moneyOrderDepositToAccount']
+      if attributes.has_key?(:'mail_to_store')
+        self.mail_to_store = attributes[:'mail_to_store']
       end
 
       if attributes.has_key?(:'restrictions')
         self.restrictions = attributes[:'restrictions']
       end
+
+      if attributes.has_key?(:'test_methods')
+        if (value = attributes[:'test_methods']).is_a?(Array)
+          self.test_methods = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -166,19 +172,18 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           accept_check_orders == o.accept_check_orders &&
-          check_accounting_code == o.check_accounting_code &&
-          check_deposit_to_account == o.check_deposit_to_account &&
+          accounting_code == o.accounting_code &&
           checks_payable_to == o.checks_payable_to &&
+          deposit_to_account == o.deposit_to_account &&
           mail_to_address1 == o.mail_to_address1 &&
           mail_to_address2 == o.mail_to_address2 &&
           mail_to_city == o.mail_to_city &&
           mail_to_country == o.mail_to_country &&
           mail_to_name == o.mail_to_name &&
-          mail_to_state == o.mail_to_state &&
-          mail_to_zip == o.mail_to_zip &&
-          money_order_accounting_code == o.money_order_accounting_code &&
-          money_order_deposit_to_account == o.money_order_deposit_to_account &&
-          restrictions == o.restrictions
+          mail_to_postal_code == o.mail_to_postal_code &&
+          mail_to_store == o.mail_to_store &&
+          restrictions == o.restrictions &&
+          test_methods == o.test_methods
     end
 
     # @see the `==` method
@@ -190,7 +195,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accept_check_orders, check_accounting_code, check_deposit_to_account, checks_payable_to, mail_to_address1, mail_to_address2, mail_to_city, mail_to_country, mail_to_name, mail_to_state, mail_to_zip, money_order_accounting_code, money_order_deposit_to_account, restrictions].hash
+      [accept_check_orders, accounting_code, checks_payable_to, deposit_to_account, mail_to_address1, mail_to_address2, mail_to_city, mail_to_country, mail_to_name, mail_to_postal_code, mail_to_store, restrictions, test_methods].hash
     end
 
     # Builds the object from hash

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