ultracart_api 3.4.8 → 3.4.12

data/lib/ultracart_api/models/payments_configuration.rb

@@ -26,13 +26,13 @@ module UltracartClient
 
     attr_accessor :credit_card
 
-    attr_accessor :e_check
+    attr_accessor :echeck
 
     attr_accessor :loan_hero
 
     attr_accessor :money_order
 
-    attr_accessor :pay_pal
+    attr_accessor :paypal
 
     attr_accessor :purchase_order
 
@@ -40,13 +40,14 @@ module UltracartClient
 
     attr_accessor :sezzle
 
+    # Internal flag used to determine if accounting codes should be shown on the screen or not.  This flag is true if the merchant has a Quickbooks integration configured.
     attr_accessor :show_accounting_code
 
     attr_accessor :switch_to_sub_tab
 
     attr_accessor :switch_to_tab
 
-    attr_accessor :we_pay
+    attr_accessor :ultracart_payments_wepay
 
     attr_accessor :wire_transfer
 
@@ -58,19 +59,19 @@ module UltracartClient
         :'cash' => :'cash',
         :'check' => :'check',
         :'cod' => :'cod',
-        :'credit_card' => :'creditCard',
-        :'e_check' => :'eCheck',
-        :'loan_hero' => :'loanHero',
-        :'money_order' => :'moneyOrder',
-        :'pay_pal' => :'payPal',
-        :'purchase_order' => :'purchaseOrder',
-        :'quote_request' => :'quoteRequest',
+        :'credit_card' => :'credit_card',
+        :'echeck' => :'echeck',
+        :'loan_hero' => :'loan_hero',
+        :'money_order' => :'money_order',
+        :'paypal' => :'paypal',
+        :'purchase_order' => :'purchase_order',
+        :'quote_request' => :'quote_request',
         :'sezzle' => :'sezzle',
-        :'show_accounting_code' => :'showAccountingCode',
+        :'show_accounting_code' => :'show_accounting_code',
         :'switch_to_sub_tab' => :'switchToSubTab',
         :'switch_to_tab' => :'switchToTab',
-        :'we_pay' => :'wePay',
-        :'wire_transfer' => :'wireTransfer'
+        :'ultracart_payments_wepay' => :'ultracart_payments_wepay',
+        :'wire_transfer' => :'wire_transfer'
       }
     end
 
@@ -83,17 +84,17 @@ module UltracartClient
         :'check' => :'PaymentsConfigurationCheck',
         :'cod' => :'PaymentsConfigurationCOD',
         :'credit_card' => :'PaymentsConfigurationCreditCard',
-        :'e_check' => :'PaymentsConfigurationEcheck',
+        :'echeck' => :'PaymentsConfigurationEcheck',
         :'loan_hero' => :'PaymentsConfigurationLoanHero',
         :'money_order' => :'PaymentsConfigurationMoneyOrder',
-        :'pay_pal' => :'PaymentsConfigurationPayPal',
+        :'paypal' => :'PaymentsConfigurationPayPal',
         :'purchase_order' => :'PaymentsConfigurationPurchaseOrder',
         :'quote_request' => :'PaymentsConfigurationQuoteRequest',
         :'sezzle' => :'PaymentsConfigurationSezzle',
         :'show_accounting_code' => :'BOOLEAN',
         :'switch_to_sub_tab' => :'String',
         :'switch_to_tab' => :'String',
-        :'we_pay' => :'PaymentsConfigurationWePay',
+        :'ultracart_payments_wepay' => :'PaymentsConfigurationWePay',
         :'wire_transfer' => :'PaymentsConfigurationWireTransfer'
       }
     end
@@ -126,40 +127,40 @@ module UltracartClient
         self.cod = attributes[:'cod']
       end
 
-      if attributes.has_key?(:'creditCard')
-        self.credit_card = attributes[:'creditCard']
+      if attributes.has_key?(:'credit_card')
+        self.credit_card = attributes[:'credit_card']
       end
 
-      if attributes.has_key?(:'eCheck')
-        self.e_check = attributes[:'eCheck']
+      if attributes.has_key?(:'echeck')
+        self.echeck = attributes[:'echeck']
       end
 
-      if attributes.has_key?(:'loanHero')
-        self.loan_hero = attributes[:'loanHero']
+      if attributes.has_key?(:'loan_hero')
+        self.loan_hero = attributes[:'loan_hero']
       end
 
-      if attributes.has_key?(:'moneyOrder')
-        self.money_order = attributes[:'moneyOrder']
+      if attributes.has_key?(:'money_order')
+        self.money_order = attributes[:'money_order']
       end
 
-      if attributes.has_key?(:'payPal')
-        self.pay_pal = attributes[:'payPal']
+      if attributes.has_key?(:'paypal')
+        self.paypal = attributes[:'paypal']
       end
 
-      if attributes.has_key?(:'purchaseOrder')
-        self.purchase_order = attributes[:'purchaseOrder']
+      if attributes.has_key?(:'purchase_order')
+        self.purchase_order = attributes[:'purchase_order']
       end
 
-      if attributes.has_key?(:'quoteRequest')
-        self.quote_request = attributes[:'quoteRequest']
+      if attributes.has_key?(:'quote_request')
+        self.quote_request = attributes[:'quote_request']
       end
 
       if attributes.has_key?(:'sezzle')
         self.sezzle = attributes[:'sezzle']
       end
 
-      if attributes.has_key?(:'showAccountingCode')
-        self.show_accounting_code = attributes[:'showAccountingCode']
+      if attributes.has_key?(:'show_accounting_code')
+        self.show_accounting_code = attributes[:'show_accounting_code']
       end
 
       if attributes.has_key?(:'switchToSubTab')
@@ -170,12 +171,12 @@ module UltracartClient
         self.switch_to_tab = attributes[:'switchToTab']
       end
 
-      if attributes.has_key?(:'wePay')
-        self.we_pay = attributes[:'wePay']
+      if attributes.has_key?(:'ultracart_payments_wepay')
+        self.ultracart_payments_wepay = attributes[:'ultracart_payments_wepay']
       end
 
-      if attributes.has_key?(:'wireTransfer')
-        self.wire_transfer = attributes[:'wireTransfer']
+      if attributes.has_key?(:'wire_transfer')
+        self.wire_transfer = attributes[:'wire_transfer']
       end
     end
 
@@ -203,17 +204,17 @@ module UltracartClient
           check == o.check &&
           cod == o.cod &&
           credit_card == o.credit_card &&
-          e_check == o.e_check &&
+          echeck == o.echeck &&
           loan_hero == o.loan_hero &&
           money_order == o.money_order &&
-          pay_pal == o.pay_pal &&
+          paypal == o.paypal &&
           purchase_order == o.purchase_order &&
           quote_request == o.quote_request &&
           sezzle == o.sezzle &&
           show_accounting_code == o.show_accounting_code &&
           switch_to_sub_tab == o.switch_to_sub_tab &&
           switch_to_tab == o.switch_to_tab &&
-          we_pay == o.we_pay &&
+          ultracart_payments_wepay == o.ultracart_payments_wepay &&
           wire_transfer == o.wire_transfer
     end
 
@@ -226,7 +227,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [affirm, amazon, cash, check, cod, credit_card, e_check, loan_hero, money_order, pay_pal, purchase_order, quote_request, sezzle, show_accounting_code, switch_to_sub_tab, switch_to_tab, we_pay, wire_transfer].hash
+      [affirm, amazon, cash, check, cod, credit_card, echeck, loan_hero, money_order, paypal, purchase_order, quote_request, sezzle, show_accounting_code, switch_to_sub_tab, switch_to_tab, ultracart_payments_wepay, wire_transfer].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/payments_configuration_affirm.rb

@@ -14,32 +14,61 @@ require 'date'
 
 module UltracartClient
   class PaymentsConfigurationAffirm
+    # Master flag indicating this merchant accepts Affirm payments
     attr_accessor :accept_affirm
 
-    attr_accessor :affirm_accounting_code
+    # Optional Quickbooks code for this payment method
+    attr_accessor :accounting_code
 
-    attr_accessor :affirm_deposit_to_account
+    # Optional Quickbooks Deposit to Account value
+    attr_accessor :deposit_to_account
 
-    attr_accessor :affirm_environment
+    # Environment
+    attr_accessor :environment
 
-    attr_accessor :affirm_financial_product_key
+    # Financial product key
+    attr_accessor :financial_product_key
 
-    attr_accessor :affirm_private_api_key
+    # Private API key
+    attr_accessor :private_api_key
 
-    attr_accessor :affirm_public_api_key
+    # Public API key
+    attr_accessor :public_api_key
 
     attr_accessor :restrictions
 
+    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
       {
-        :'accept_affirm' => :'acceptAffirm',
-        :'affirm_accounting_code' => :'affirmAccountingCode',
-        :'affirm_deposit_to_account' => :'affirmDepositToAccount',
-        :'affirm_environment' => :'affirmEnvironment',
-        :'affirm_financial_product_key' => :'affirmFinancialProductKey',
-        :'affirm_private_api_key' => :'affirmPrivateApiKey',
-        :'affirm_public_api_key' => :'affirmPublicApiKey',
+        :'accept_affirm' => :'accept_affirm',
+        :'accounting_code' => :'accounting_code',
+        :'deposit_to_account' => :'deposit_to_account',
+        :'environment' => :'environment',
+        :'financial_product_key' => :'financial_product_key',
+        :'private_api_key' => :'private_api_key',
+        :'public_api_key' => :'public_api_key',
         :'restrictions' => :'restrictions'
       }
     end
@@ -48,12 +77,12 @@ module UltracartClient
     def self.swagger_types
       {
         :'accept_affirm' => :'BOOLEAN',
-        :'affirm_accounting_code' => :'String',
-        :'affirm_deposit_to_account' => :'String',
-        :'affirm_environment' => :'String',
-        :'affirm_financial_product_key' => :'String',
-        :'affirm_private_api_key' => :'String',
-        :'affirm_public_api_key' => :'String',
+        :'accounting_code' => :'String',
+        :'deposit_to_account' => :'String',
+        :'environment' => :'String',
+        :'financial_product_key' => :'String',
+        :'private_api_key' => :'String',
+        :'public_api_key' => :'String',
         :'restrictions' => :'PaymentsConfigurationRestrictions'
       }
     end
@@ -66,32 +95,32 @@ 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?(:'acceptAffirm')
-        self.accept_affirm = attributes[:'acceptAffirm']
+      if attributes.has_key?(:'accept_affirm')
+        self.accept_affirm = attributes[:'accept_affirm']
       end
 
-      if attributes.has_key?(:'affirmAccountingCode')
-        self.affirm_accounting_code = attributes[:'affirmAccountingCode']
+      if attributes.has_key?(:'accounting_code')
+        self.accounting_code = attributes[:'accounting_code']
       end
 
-      if attributes.has_key?(:'affirmDepositToAccount')
-        self.affirm_deposit_to_account = attributes[:'affirmDepositToAccount']
+      if attributes.has_key?(:'deposit_to_account')
+        self.deposit_to_account = attributes[:'deposit_to_account']
       end
 
-      if attributes.has_key?(:'affirmEnvironment')
-        self.affirm_environment = attributes[:'affirmEnvironment']
+      if attributes.has_key?(:'environment')
+        self.environment = attributes[:'environment']
       end
 
-      if attributes.has_key?(:'affirmFinancialProductKey')
-        self.affirm_financial_product_key = attributes[:'affirmFinancialProductKey']
+      if attributes.has_key?(:'financial_product_key')
+        self.financial_product_key = attributes[:'financial_product_key']
       end
 
-      if attributes.has_key?(:'affirmPrivateApiKey')
-        self.affirm_private_api_key = attributes[:'affirmPrivateApiKey']
+      if attributes.has_key?(:'private_api_key')
+        self.private_api_key = attributes[:'private_api_key']
       end
 
-      if attributes.has_key?(:'affirmPublicApiKey')
-        self.affirm_public_api_key = attributes[:'affirmPublicApiKey']
+      if attributes.has_key?(:'public_api_key')
+        self.public_api_key = attributes[:'public_api_key']
       end
 
       if attributes.has_key?(:'restrictions')
@@ -109,21 +138,33 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      environment_validator = EnumAttributeValidator.new('String', ['Live', 'Sandbox'])
+      return false unless environment_validator.valid?(@environment)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] environment Object to be assigned
+    def environment=(environment)
+      validator = EnumAttributeValidator.new('String', ['Live', 'Sandbox'])
+      unless validator.valid?(environment)
+        fail ArgumentError, 'invalid value for "environment", must be one of #{validator.allowable_values}.'
+      end
+      @environment = environment
+    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 &&
           accept_affirm == o.accept_affirm &&
-          affirm_accounting_code == o.affirm_accounting_code &&
-          affirm_deposit_to_account == o.affirm_deposit_to_account &&
-          affirm_environment == o.affirm_environment &&
-          affirm_financial_product_key == o.affirm_financial_product_key &&
-          affirm_private_api_key == o.affirm_private_api_key &&
-          affirm_public_api_key == o.affirm_public_api_key &&
+          accounting_code == o.accounting_code &&
+          deposit_to_account == o.deposit_to_account &&
+          environment == o.environment &&
+          financial_product_key == o.financial_product_key &&
+          private_api_key == o.private_api_key &&
+          public_api_key == o.public_api_key &&
           restrictions == o.restrictions
     end
 
@@ -136,7 +177,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accept_affirm, affirm_accounting_code, affirm_deposit_to_account, affirm_environment, affirm_financial_product_key, affirm_private_api_key, affirm_public_api_key, restrictions].hash
+      [accept_affirm, accounting_code, deposit_to_account, environment, financial_product_key, private_api_key, public_api_key, restrictions].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/payments_configuration_amazon.rb

@@ -14,33 +14,40 @@ require 'date'
 
 module UltracartClient
   class PaymentsConfigurationAmazon
+    # Master flag to determine if this merchant accepts Pay by Amazon
     attr_accessor :accept_amazon
 
-    attr_accessor :amazon_access_key_id
+    # Amazon access key ID
+    attr_accessor :access_key_id
 
-    attr_accessor :amazon_accounting_code
-
-    attr_accessor :amazon_deposit_to_account
+    # Optional accounting code for use with Quickbooks integrations
+    attr_accessor :accounting_code
 
+    # Amazon merchant ID
     attr_accessor :amazon_merchant_id
 
-    attr_accessor :amazon_sandbox
-
-    attr_accessor :amazon_secret_access_key
+    # Optional deposit to account field for use with Quickbooks integrations
+    attr_accessor :deposit_to_account
 
     attr_accessor :restrictions
 
+    # True if transactions should run against the Amazon sandbox.  Useful for testing not configurations
+    attr_accessor :sandbox
+
+    # Amazon secret access key
+    attr_accessor :secret_access_key
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'accept_amazon' => :'acceptAmazon',
-        :'amazon_access_key_id' => :'amazonAccessKeyId',
-        :'amazon_accounting_code' => :'amazonAccountingCode',
-        :'amazon_deposit_to_account' => :'amazonDepositToAccount',
-        :'amazon_merchant_id' => :'amazonMerchantId',
-        :'amazon_sandbox' => :'amazonSandbox',
-        :'amazon_secret_access_key' => :'amazonSecretAccessKey',
-        :'restrictions' => :'restrictions'
+        :'accept_amazon' => :'accept_amazon',
+        :'access_key_id' => :'access_key_id',
+        :'accounting_code' => :'accounting_code',
+        :'amazon_merchant_id' => :'amazon_merchant_id',
+        :'deposit_to_account' => :'deposit_to_account',
+        :'restrictions' => :'restrictions',
+        :'sandbox' => :'sandbox',
+        :'secret_access_key' => :'secret_access_key'
       }
     end
 
@@ -48,13 +55,13 @@ module UltracartClient
     def self.swagger_types
       {
         :'accept_amazon' => :'BOOLEAN',
-        :'amazon_access_key_id' => :'String',
-        :'amazon_accounting_code' => :'String',
-        :'amazon_deposit_to_account' => :'String',
+        :'access_key_id' => :'String',
+        :'accounting_code' => :'String',
         :'amazon_merchant_id' => :'String',
-        :'amazon_sandbox' => :'BOOLEAN',
-        :'amazon_secret_access_key' => :'String',
-        :'restrictions' => :'PaymentsConfigurationRestrictions'
+        :'deposit_to_account' => :'String',
+        :'restrictions' => :'PaymentsConfigurationRestrictions',
+        :'sandbox' => :'BOOLEAN',
+        :'secret_access_key' => :'String'
       }
     end
 
@@ -66,36 +73,36 @@ 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?(:'acceptAmazon')
-        self.accept_amazon = attributes[:'acceptAmazon']
+      if attributes.has_key?(:'accept_amazon')
+        self.accept_amazon = attributes[:'accept_amazon']
       end
 
-      if attributes.has_key?(:'amazonAccessKeyId')
-        self.amazon_access_key_id = attributes[:'amazonAccessKeyId']
+      if attributes.has_key?(:'access_key_id')
+        self.access_key_id = attributes[:'access_key_id']
       end
 
-      if attributes.has_key?(:'amazonAccountingCode')
-        self.amazon_accounting_code = attributes[:'amazonAccountingCode']
+      if attributes.has_key?(:'accounting_code')
+        self.accounting_code = attributes[:'accounting_code']
       end
 
-      if attributes.has_key?(:'amazonDepositToAccount')
-        self.amazon_deposit_to_account = attributes[:'amazonDepositToAccount']
+      if attributes.has_key?(:'amazon_merchant_id')
+        self.amazon_merchant_id = attributes[:'amazon_merchant_id']
       end
 
-      if attributes.has_key?(:'amazonMerchantId')
-        self.amazon_merchant_id = attributes[:'amazonMerchantId']
+      if attributes.has_key?(:'deposit_to_account')
+        self.deposit_to_account = attributes[:'deposit_to_account']
       end
 
-      if attributes.has_key?(:'amazonSandbox')
-        self.amazon_sandbox = attributes[:'amazonSandbox']
+      if attributes.has_key?(:'restrictions')
+        self.restrictions = attributes[:'restrictions']
       end
 
-      if attributes.has_key?(:'amazonSecretAccessKey')
-        self.amazon_secret_access_key = attributes[:'amazonSecretAccessKey']
+      if attributes.has_key?(:'sandbox')
+        self.sandbox = attributes[:'sandbox']
       end
 
-      if attributes.has_key?(:'restrictions')
-        self.restrictions = attributes[:'restrictions']
+      if attributes.has_key?(:'secret_access_key')
+        self.secret_access_key = attributes[:'secret_access_key']
       end
     end
 
@@ -118,13 +125,13 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           accept_amazon == o.accept_amazon &&
-          amazon_access_key_id == o.amazon_access_key_id &&
-          amazon_accounting_code == o.amazon_accounting_code &&
-          amazon_deposit_to_account == o.amazon_deposit_to_account &&
+          access_key_id == o.access_key_id &&
+          accounting_code == o.accounting_code &&
           amazon_merchant_id == o.amazon_merchant_id &&
-          amazon_sandbox == o.amazon_sandbox &&
-          amazon_secret_access_key == o.amazon_secret_access_key &&
-          restrictions == o.restrictions
+          deposit_to_account == o.deposit_to_account &&
+          restrictions == o.restrictions &&
+          sandbox == o.sandbox &&
+          secret_access_key == o.secret_access_key
     end
 
     # @see the `==` method
@@ -136,7 +143,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accept_amazon, amazon_access_key_id, amazon_accounting_code, amazon_deposit_to_account, amazon_merchant_id, amazon_sandbox, amazon_secret_access_key, restrictions].hash
+      [accept_amazon, access_key_id, accounting_code, amazon_merchant_id, deposit_to_account, restrictions, sandbox, secret_access_key].hash
     end
 
     # Builds the object from hash