braintree 2.98.0 → 4.23.0

data/lib/braintree/transaction_gateway.rb

@@ -1,5 +1,5 @@
 module Braintree
-  class TransactionGateway # :nodoc:
+  class TransactionGateway
     include BaseModule
 
     def initialize(gateway)
@@ -9,6 +9,14 @@ module Braintree
     end
 
     def create(attributes)
+      # NEXT_MAJOR_VERSION remove this check
+      if attributes.has_key?(:venmo_sdk_payment_method_code) || attributes.has_key?(:venmo_sdk_session)
+        warn "[DEPRECATED] The Venmo SDK integration is Unsupported. Please update your integration to use Pay with Venmo instead."
+      end
+      # NEXT_MAJOR_VERSION remove this check
+      if attributes.has_key?(:three_d_secure_token)
+        warn "[DEPRECATED] Passing :three_d_secure_token to create is deprecated. Please use :three_d_secure_authentication_id"
+      end
       Util.verify_keys(TransactionGateway._create_signature, attributes)
       _do_create "/transactions", :transaction => attributes
     end
@@ -52,19 +60,8 @@ module Braintree
       return_object_or_raise(:transaction) { clone_transaction(*args) }
     end
 
-    # Deprecated
-    def create_from_transparent_redirect(query_string)
-      params = @gateway.transparent_redirect.parse_and_validate_query_string query_string
-      _do_create("/transactions/all/confirm_transparent_redirect_request", :id => params[:id])
-    end
-
-    def create_transaction_url
-      warn "[DEPRECATED] Transaction.create_transaction_url is deprecated. Please use TransparentRedirect.url"
-      "#{@config.base_merchant_url}/transactions/all/create_via_transparent_redirect_request"
-    end
-
     def credit(attributes)
-      create(attributes.merge(:type => 'credit'))
+      create(attributes.merge(:type => "credit"))
     end
 
     def credit!(*args)
@@ -72,7 +69,7 @@ module Braintree
     end
 
     def find(id)
-      raise ArgumentError if id.nil? || id.strip.to_s == ""
+      raise ArgumentError, "id can not be empty" if id.nil? || id.strip.to_s == ""
       response = @config.http.get("#{@config.base_merchant_path}/transactions/#{id}")
       Transaction._new(@gateway, response[:transaction])
     rescue NotFoundError
@@ -83,7 +80,7 @@ module Braintree
       options = if amount_or_options.is_a?(Hash)
                   amount_or_options
                 else
-                  { :amount => amount_or_options }
+                  {:amount => amount_or_options}
                 end
 
       Util.verify_keys(TransactionGateway._refund_signature, options)
@@ -108,13 +105,23 @@ module Braintree
     end
 
     def sale(attributes)
-      create(attributes.merge(:type => 'sale'))
+      create(attributes.merge(:type => "sale"))
     end
 
     def sale!(*args)
       return_object_or_raise(:transaction) { sale(*args) }
     end
 
+    def package_tracking(transaction_id, package_tracking_request)
+      raise ArgumentError, "transaction_id is invalid" unless transaction_id =~ /\A[0-9a-z]+\z/
+      Util.verify_keys(TransactionGateway._package_tracking_request_signature, package_tracking_request)
+      _do_create "/transactions/#{transaction_id}/shipments", :shipment => package_tracking_request
+    end
+
+    def package_tracking!(*args)
+      return_object_or_raise(:transaction) { package_tracking(*args) }
+    end
+
     def search(&block)
       search = TransactionSearch.new
       block.call(search) if block
@@ -124,7 +131,7 @@ module Braintree
       if response.has_key?(:search_results)
         ResourceCollection.new(response) { |ids| _fetch_transactions(search, ids) }
       else
-        raise DownForMaintenanceError
+        raise UnexpectedError, "expected :search_results"
       end
     end
 
@@ -150,6 +157,18 @@ module Braintree
       return_object_or_raise(:transaction) { submit_for_settlement(*args) }
     end
 
+    def adjust_authorization(transaction_id, amount)
+      raise ArgumentError, "transaction_id is invalid" unless transaction_id =~ /\A[0-9a-z]+\z/
+      Util.verify_keys(TransactionGateway._adjust_authorization_signature, {})
+      transaction_params = {:amount => amount}
+      response = @config.http.put("#{@config.base_merchant_path}/transactions/#{transaction_id}/adjust_authorization", :transaction => transaction_params)
+      _handle_transaction_response(response)
+    end
+
+    def adjust_authorization!(*args)
+      return_object_or_raise(:transaction) { adjust_authorization(*args) }
+    end
+
     def update_details(transaction_id, options = {})
       raise ArgumentError, "transaction_id is invalid" unless transaction_id =~ /\A[0-9a-z]+\z/
       Util.verify_keys(TransactionGateway._update_details_signature, options)
@@ -159,7 +178,7 @@ module Braintree
 
     def submit_for_partial_settlement(authorized_transaction_id, amount = nil, options = {})
       raise ArgumentError, "authorized_transaction_id is invalid" unless authorized_transaction_id =~ /\A[0-9a-z]+\z/
-      Util.verify_keys(TransactionGateway._submit_for_settlement_signature, options)
+      Util.verify_keys(TransactionGateway._submit_for_partial_settlement_signature, options)
       transaction_params = {:amount => amount}.merge(options)
       response = @config.http.post("#{@config.base_merchant_path}/transactions/#{authorized_transaction_id}/submit_for_partial_settlement", :transaction => transaction_params)
       _handle_transaction_response(response)
@@ -178,40 +197,62 @@ module Braintree
       return_object_or_raise(:transaction) { void(*args) }
     end
 
-    def self._clone_signature # :nodoc:
+    def self._package_tracking_request_signature
+      [
+        :carrier,
+        {:line_items => [:commodity_code, :description, :discount_amount, :image_url, :kind, :name, :product_code, :quantity, :tax_amount, :total_amount, :unit_amount, :unit_of_measure, :unit_tax_amount, :upc_code, :upc_type, :url]},
+        :notify_payer, :tracking_number,
+      ]
+    end
+
+    def self._clone_signature
       [:amount, :channel, {:options => [:submit_for_settlement]}]
     end
 
-    def self._create_signature # :nodoc:
+    # NEXT_MAJOR_VERSION Remove venmo_sdk_payment_method_code, venmo_sdk_session, and three_d_secure_token
+    # The old venmo SDK class has been deprecated
+    # three_d_secure_token has been deprecated in favor of three_d_secure_authentication_id
+    def self._create_signature
       [
-        :amount, :customer_id, :merchant_account_id, :order_id, :channel, :payment_method_token,
-        :purchase_order_number, :recurring, :transaction_source, :shipping_address_id, :type, :tax_amount, :tax_exempt,
-        :venmo_sdk_payment_method_code, :device_session_id, :service_fee_amount, :device_data, :fraud_merchant_id,
-        :shipping_amount, :discount_amount, :ships_from_postal_code,
-        :billing_address_id, :payment_method_nonce, :three_d_secure_token,
-        :shared_payment_method_token, :shared_billing_address_id, :shared_customer_id, :shared_shipping_address_id, :shared_payment_method_nonce,
-        {:line_items => [:quantity, :name, :description, :kind, :unit_amount, :unit_tax_amount, :total_amount, :discount_amount, :tax_amount, :unit_of_measure, :product_code, :commodity_code, :url]},
-        {:risk_data => [:customer_browser, :customer_ip]},
-        {:credit_card => [:token, :cardholder_name, :cvv, :expiration_date, :expiration_month, :expiration_year, :number]},
-        {:customer => [:id, :company, :email, :fax, :first_name, :last_name, :phone, :website]},
+        :amount, :billing_address_id, :channel, :currency_iso_code, :customer_id, :device_data,
+        :discount_amount, :exchange_rate_quote_id, :foreign_retailer,
+        :merchant_account_id, :order_id, :payment_method_nonce, :payment_method_token,
+        :product_sku, :purchase_order_number, :service_fee_amount, :shared_billing_address_id,
+        :shared_customer_id, :shared_payment_method_nonce, :shared_payment_method_token,
+        :shared_shipping_address_id, :shipping_address_id, :shipping_amount, :shipping_tax_amount,
+        :ships_from_postal_code, :tax_amount, :tax_exempt, :three_d_secure_authentication_id,:three_d_secure_token, #Deprecated
+        :transaction_source, :type, :venmo_sdk_payment_method_code, # Deprecated
+        :sca_exemption,
+        {:apple_pay_card => [:number, :cardholder_name, :cryptogram, :expiration_month, :expiration_year, :eci_indicator]},
         {
           :billing => AddressGateway._shared_signature
         },
-        {
-          :shipping => AddressGateway._shared_signature
-        },
-        {
-          :three_d_secure_pass_thru => [
-            :eci_flag,
-            :cavv,
-            :xid,
-            :three_d_secure_version,
-            :authentication_response,
-            :directory_response,
-            :cavv_algorithm,
-            :ds_transaction_id,
-          ]
-        },
+        {:credit_card => [:token, :cardholder_name, :cvv, :expiration_date, :expiration_month, :expiration_year, :number, {:payment_reader_card_details => [:encrypted_card_data, :key_serial_number]}, {:network_tokenization_attributes => [:cryptogram, :ecommerce_indicator, :token_requestor_id]}]},
+        {:customer => [:id, :company, :email, :fax, :first_name, :last_name, :phone, :website]},
+        {:custom_fields => :_any_key_},
+        {:descriptor => [:name, :phone, :url]},
+        {:external_vault => [
+          :status,
+          :previous_network_transaction_id,
+        ]},
+        {:google_pay_card => [:number, :cryptogram, :google_transaction_id, :expiration_month, :expiration_year, :source_card_type, :source_card_last_four, :eci_indicator]},
+        {:industry => [
+          :industry_type,
+          {:data => [
+            :country_code, :date_of_birth, :folio_number, :check_in_date, :check_out_date, :travel_package, :lodging_check_in_date, :lodging_check_out_date, :departure_date, :lodging_name, :room_rate, :room_tax,
+            :passenger_first_name, :passenger_last_name, :passenger_middle_initial, :passenger_title, :issued_date, :travel_agency_name, :travel_agency_code, :ticket_number,
+            :issuing_carrier_code, :customer_code, :fare_amount, :fee_amount, :tax_amount, :restricted_ticket, :no_show, :advanced_deposit, :fire_safe, :property_phone, :ticket_issuer_address, :arrival_date,
+            {:legs => [
+              :conjunction_ticket, :exchange_ticket, :coupon_number, :service_class, :carrier_code, :fare_basis_code, :flight_number, :departure_date, :departure_airport_code, :departure_time,
+              :arrival_airport_code, :arrival_time, :stopover_permitted, :fare_amount, :fee_amount, :tax_amount, :endorsement_or_restrictions,
+            ]},
+            {:additional_charges => [
+              :kind, :amount,
+            ]},
+          ]},
+        ]},
+        {:installments => [:count]},
+        {:line_items => [:commodity_code, :description, :discount_amount, :image_url, :kind, :name, :product_code, :quantity, :tax_amount, :total_amount, :unit_amount, :unit_of_measure, :unit_tax_amount, :upc_code, :upc_type, :url]},
         {:options => [
           :hold_in_escrow,
           :store_in_vault,
@@ -219,32 +260,50 @@ module Braintree
           :submit_for_settlement,
           :add_billing_address_to_payment_method,
           :store_shipping_address_in_vault,
-          :venmo_sdk_session,
+          :venmo_sdk_session, # Deprecated
           :payee_id,
           :payee_email,
           :skip_advanced_fraud_checking,
           :skip_avs,
           :skip_cvv,
           {:paypal => [:custom_field, :payee_id, :payee_email, :description, {:supplementary_data => :_any_key_}]},
+          {:processing_overrides => [:customer_email, :customer_first_name, :customer_last_name, :customer_tax_identifier]},
           {:three_d_secure => [:required]},
           {:amex_rewards => [:request_id, :points, :currency_amount, :currency_iso_code]},
           {:venmo => [:profile_id]},
-          {:credit_card => [:account_type]},
+          {:credit_card => [:account_type, :process_debit_as_credit]},
         ]
         },
-        {:external_vault => [
-          :status,
-          :previous_network_transaction_id,
-        ]},
-        {:custom_fields => :_any_key_},
-        {:descriptor => [:name, :phone, :url]},
         {:paypal_account => [:email, :token, :paypal_data, :payee_id, :payee_email, :payer_id, :payment_id]},
+        {:risk_data => [:customer_browser, :customer_device_id, :customer_ip, :customer_location_zip, :customer_tenure]},
+        {
+          :shipping => AddressGateway._shared_signature + [:shipping_method],
+        },
+        {
+          :three_d_secure_pass_thru => [
+            :eci_flag,
+            :cavv,
+            :xid,
+            :three_d_secure_version,
+            :authentication_response,
+            :directory_response,
+            :cavv_algorithm,
+            :ds_transaction_id,
+          ]
+        },
+      ]
+    end
+
+    def self._submit_for_settlement_signature
+      [
+        :order_id,
+        {:descriptor => [:name, :phone, :url]},
         {:industry => [
           :industry_type,
           {:data => [
-            :folio_number, :check_in_date, :check_out_date, :travel_package, :lodging_check_in_date, :lodging_check_out_date, :departure_date, :lodging_name, :room_rate, :room_tax,
+            :country_code, :date_of_birth, :folio_number, :check_in_date, :check_out_date, :travel_package, :lodging_check_in_date, :lodging_check_out_date, :departure_date, :lodging_name, :room_rate, :room_tax,
             :passenger_first_name, :passenger_last_name, :passenger_middle_initial, :passenger_title, :issued_date, :travel_agency_name, :travel_agency_code, :ticket_number,
-            :issuing_carrier_code, :customer_code, :fare_amount, :fee_amount, :tax_amount, :restricted_ticket, :no_show, :advanced_deposit, :fire_safe, :property_phone,
+            :issuing_carrier_code, :customer_code, :fare_amount, :fee_amount, :tax_amount, :restricted_ticket, :no_show, :advanced_deposit, :fire_safe, :property_phone, :ticket_issuer_address, :arrival_date,
             {:legs => [
               :conjunction_ticket, :exchange_ticket, :coupon_number, :service_class, :carrier_code, :fare_basis_code, :flight_number, :departure_date, :departure_airport_code, :departure_time,
               :arrival_airport_code, :arrival_time, :stopover_permitted, :fare_amount, :fee_amount, :tax_amount, :endorsement_or_restrictions,
@@ -254,19 +313,30 @@ module Braintree
             ]},
           ]},
         ]},
-        {:apple_pay_card => [:number, :cardholder_name, :cryptogram, :expiration_month, :expiration_year, :eci_indicator]},
-        {:android_pay_card => [:number, :cryptogram, :google_transaction_id, :expiration_month, :expiration_year, :source_card_type, :source_card_last_four, :eci_indicator]}
+        :purchase_order_number,
+        :tax_amount,
+        :tax_exempt,
+        :discount_amount,
+        :shipping_amount,
+        :shipping_tax_amount,
+        :ships_from_postal_code,
+        :line_items => [:commodity_code, :description, :discount_amount, :image_url, :kind, :name, :product_code, :quantity, :tax_amount, :total_amount, :unit_amount, :unit_of_measure, :unit_tax_amount, :upc_code, :upc_type, :url],
       ]
     end
 
-    def self._submit_for_settlement_signature # :nodoc:
+    def self._submit_for_partial_settlement_signature
+      _submit_for_settlement_signature + [
+        :final_capture
+      ]
+    end
+
+    def self._adjust_authorization_signature
       [
-        :order_id,
-        {:descriptor => [:name, :phone, :url]},
+        :amount
       ]
     end
 
-    def self._update_details_signature # :nodoc:
+    def self._update_details_signature
       [
         :amount,
         :order_id,
@@ -277,16 +347,20 @@ module Braintree
     def self._refund_signature
       [
         :amount,
-        :order_id
+        :merchant_account_id,
+        :order_id,
       ]
     end
 
-    def _do_create(path, params=nil) # :nodoc:
+    def _do_create(path, params=nil)
+      if !params.nil?
+        params = Util.replace_key(params, :google_pay_card, :android_pay_card)
+      end
       response = @config.http.post("#{@config.base_merchant_path}#{path}", params)
       _handle_transaction_response(response)
     end
 
-    def _fetch_transactions(search, ids) # :nodoc:
+    def _fetch_transactions(search, ids)
       search.ids.in ids
       response = @config.http.post("#{@config.base_merchant_path}/transactions/advanced_search", {:search => search.to_hash})
       attributes = response[:credit_card_transactions]

data/lib/braintree/transaction_line_item.rb

@@ -1,21 +1,24 @@
 module Braintree
   class TransactionLineItem
     include BaseModule
-    attr_reader :quantity
-    attr_reader :name
+    attr_reader :commodity_code
     attr_reader :description
-    attr_reader :kind
-    attr_reader :unit_amount
-    attr_reader :unit_tax_amount
-    attr_reader :unit_of_measure
     attr_reader :discount_amount
+    attr_reader :image_url
+    attr_reader :kind
+    attr_reader :name
+    attr_reader :product_code
+    attr_reader :quantity
     attr_reader :tax_amount
     attr_reader :total_amount
-    attr_reader :product_code
-    attr_reader :commodity_code
+    attr_reader :unit_amount
+    attr_reader :unit_of_measure
+    attr_reader :unit_tax_amount
+    attr_reader :upc_code
+    attr_reader :upc_type
     attr_reader :url
 
-    def initialize(gateway, attributes) # :nodoc:
+    def initialize(gateway, attributes)
       @gateway = gateway
       set_instance_variables_from_hash(attributes)
       @quantity = Util.to_big_decimal(quantity)
@@ -28,8 +31,8 @@ module Braintree
 
     class << self
       protected :new
-      def _new(*args) # :nodoc:
-        self.new *args
+      def _new(*args)
+        self.new(*args)
       end
     end
 

data/lib/braintree/transaction_line_item_gateway.rb

@@ -1,5 +1,5 @@
 module Braintree
-  class TransactionLineItemGateway # :nodoc:
+  class TransactionLineItemGateway
     def initialize(gateway)
       @gateway = gateway
       @config = gateway.config

data/lib/braintree/transaction_review.rb

@@ -0,0 +1,18 @@
+module Braintree
+  class TransactionReview
+    include BaseModule
+
+    attr_reader :transaction_id, :decision, :reviewer_email, :reviewer_note, :reviewer_time
+
+    def initialize(attributes)
+      set_instance_variables_from_hash(attributes)
+    end
+
+    class << self
+      protected :new
+      def _new(*args)
+        self.new(*args)
+      end
+    end
+  end
+end

data/lib/braintree/transaction_search.rb

@@ -1,5 +1,5 @@
 module Braintree
-  class TransactionSearch < AdvancedSearch # :nodoc:
+  class TransactionSearch < AdvancedSearch
     text_fields(
       :billing_company,
       :billing_country_name,
@@ -28,7 +28,7 @@ module Braintree
       :paypal_authorization_id,
       :paypal_payer_email,
       :processor_authorization_code,
-      :europe_bank_account_iban,
+      :sepa_debit_paypal_v2_order_id,
       :settlement_batch_id,
       :shipping_company,
       :shipping_country_name,
@@ -38,7 +38,8 @@ module Braintree
       :shipping_locality,
       :shipping_postal_code,
       :shipping_region,
-      :shipping_street_address
+      :shipping_street_address,
+      :store_id,
     )
 
     equality_fields :credit_card_expiration_date
@@ -53,19 +54,22 @@ module Braintree
       CreditCard::CustomerLocation::International,
       CreditCard::CustomerLocation::US
     ]
+    multiple_value_field :debit_network, :allows => CreditCard::DebitNetwork::All
     multiple_value_field :ids
-    multiple_value_field :payment_instrument_type
-    multiple_value_field :user
     multiple_value_field :merchant_account_id
-    multiple_value_field :status, :allows => Transaction::Status::All
+    multiple_value_field :payment_instrument_type
+    multiple_value_field :reason_code
     multiple_value_field :source
+    multiple_value_field :status, :allows => Transaction::Status::All
+    multiple_value_field :store_ids
     multiple_value_field :type, :allows => Transaction::Type::All
+    multiple_value_field :user
 
     key_value_fields :refund
 
     range_fields :amount, :created_at, :authorization_expired_at, :authorized_at,
                  :failed_at, :gateway_rejected_at, :processor_declined_at,
                  :settled_at, :submitted_for_settlement_at, :voided_at,
-                 :disbursement_date, :dispute_date
+                 :disbursement_date, :dispute_date, :ach_return_responses_created_at
   end
 end

data/lib/braintree/unknown_payment_method.rb

@@ -19,8 +19,8 @@ module Braintree
       "https://assets.braintreegateway.com/payment_method_logo/unknown.png"
     end
 
-    def self._new(*args) # :nodoc:
-      self.new *args
+    def self._new(*args)
+      self.new(*args)
     end
   end
 end

data/lib/braintree/us_bank_account.rb

@@ -14,7 +14,7 @@ module Braintree
     attr_reader :verifications
     attr_reader :verified
 
-    def initialize(gateway, attributes) # :nodoc:
+    def initialize(gateway, attributes)
       @gateway = gateway
       set_instance_variables_from_hash(attributes)
       @ach_mandate = AchMandate.new(attributes[:ach_mandate]) if attributes[:ach_mandate]
@@ -34,8 +34,8 @@ module Braintree
       protected :new
     end
 
-    def self._new(*args) # :nodoc:
-      self.new *args
+    def self._new(*args)
+      self.new(*args)
     end
 
     def self.find(*args)
@@ -45,8 +45,8 @@ module Braintree
     def self.sale(token, transaction_attributes)
       Configuration.gateway.transaction.sale(transaction_attributes.merge(
           :payment_method_token => token,
-          :options => { :submit_for_settlement => true }
-        )
+          :options => {:submit_for_settlement => true},
+        ),
       )
     end
 

data/lib/braintree/us_bank_account_verification.rb

@@ -22,33 +22,41 @@ module Braintree
       All = [IndependentCheck, NetworkCheck, TokenizedCheck, MicroTransfers]
     end
 
+    module VerificationAddOns
+      CustomerVerification = "customer_verification"
+
+      All = [CustomerVerification]
+    end
+
+    attr_reader :additional_processor_response
+    attr_reader :created_at
+    attr_reader :gateway_rejection_reason
     attr_reader :id
-    attr_reader :status
-    attr_reader :verification_determined_at
-    attr_reader :verification_method
+    attr_reader :merchant_account_id
     attr_reader :processor_response_code
     attr_reader :processor_response_text
-    attr_reader :merchant_account_id
-    attr_reader :gateway_rejection_reason
+    attr_reader :status
     attr_reader :us_bank_account
-    attr_reader :created_at
+    attr_reader :verification_determined_at
+    attr_reader :verification_method
 
-    def initialize(attributes) # :nodoc:
+    def initialize(attributes)
       set_instance_variables_from_hash(attributes)
     end
 
-    def inspect # :nodoc:
+    def inspect
       attr_order = [
-        :status,
-        :processor_response_code,
-        :processor_response_text,
-        :merchant_account_id,
+        :additional_processor_response,
+        :created_at,
         :gateway_rejection_reason,
         :id,
+        :merchant_account_id,
+        :processor_response_code,
+        :processor_response_text,
+        :status,
         :us_bank_account,
-        :verification_method,
         :verification_determined_at,
-        :created_at
+        :verification_method
       ]
 
       formatted_attrs = attr_order.map do |attr|
@@ -62,8 +70,8 @@ module Braintree
       protected :new
     end
 
-    def self._new(*args) # :nodoc:
-      self.new *args
+    def self._new(*args)
+      self.new(*args)
     end
 
     def self.confirm_micro_transfer_amounts(*args)

data/lib/braintree/us_bank_account_verification_gateway.rb

@@ -18,7 +18,7 @@ module Braintree
         ErrorResult.new(@gateway, response[:api_error_response])
       else
         SuccessfulResult.new(
-          :us_bank_account_verification => UsBankAccountVerification._new(response[:us_bank_account_verification])
+          :us_bank_account_verification => UsBankAccountVerification._new(response[:us_bank_account_verification]),
         )
       end
     rescue NotFoundError

data/lib/braintree/us_bank_account_verification_search.rb

@@ -1,5 +1,5 @@
 module Braintree
-  class UsBankAccountVerificationSearch < AdvancedSearch # :nodoc:
+  class UsBankAccountVerificationSearch < AdvancedSearch
      text_fields(
        :id,
        :account_holder_name,