braintree 2.74.0 → 4.12.0

data/lib/braintree/transaction.rb

@@ -1,20 +1,21 @@
 module Braintree
   class Transaction
     include BaseModule
+    include Braintree::Util::IdEquality
 
     module CreatedUsing
-      FullInformation = 'full_information'
-      Token = 'token'
-      Unrecognized = 'unrecognized'
+      FullInformation = "full_information"
+      Token = "token"
+      Unrecognized = "unrecognized"
     end
 
     module EscrowStatus
-      HoldPending    = 'hold_pending'
-      Held           = 'held'
-      ReleasePending = 'release_pending'
-      Released       = 'released'
-      Refunded       = 'refunded'
-      Unrecognized   = 'unrecognized'
+      HoldPending    = "hold_pending"
+      Held           = "held"
+      ReleasePending = "release_pending"
+      Released       = "released"
+      Refunded       = "refunded"
+      Unrecognized   = "unrecognized"
     end
 
     module GatewayRejectionReason
@@ -23,26 +24,29 @@ module Braintree
       AVSAndCVV    = "avs_and_cvv"
       CVV          = "cvv"
       Duplicate    = "duplicate"
+      ExcessiveRetry = "excessive_retry"
       Fraud        = "fraud"
+      RiskThreshold = "risk_threshold"
       ThreeDSecure = "three_d_secure"
+      TokenIssuance = "token_issuance"
       Unrecognized = "unrecognized"
     end
 
     module Status
-      AuthorizationExpired   = 'authorization_expired'
-      Authorizing            = 'authorizing'
-      Authorized             = 'authorized'
-      GatewayRejected        = 'gateway_rejected'
-      Failed                 = 'failed'
-      ProcessorDeclined      = 'processor_declined'
-      Settled                = 'settled'
-      SettlementConfirmed    = 'settlement_confirmed'
-      SettlementDeclined     = 'settlement_declined'
-      SettlementPending      = 'settlement_pending'
-      Settling               = 'settling'
-      SubmittedForSettlement = 'submitted_for_settlement'
-      Voided                 = 'voided'
-      Unrecognized           = 'unrecognized'
+      AuthorizationExpired   = "authorization_expired"
+      Authorizing            = "authorizing"
+      Authorized             = "authorized"
+      GatewayRejected        = "gateway_rejected"
+      Failed                 = "failed"
+      ProcessorDeclined      = "processor_declined"
+      Settled                = "settled"
+      SettlementConfirmed    = "settlement_confirmed"
+      SettlementDeclined     = "settlement_declined"
+      SettlementPending      = "settlement_pending"
+      Settling               = "settling"
+      SubmittedForSettlement = "submitted_for_settlement"
+      Voided                 = "voided"
+      Unrecognized           = "unrecognized"
 
       All = constants.map { |c| const_get(c) }
     end
@@ -57,6 +61,18 @@ module Braintree
     module IndustryType
       Lodging = "lodging"
       TravelAndCruise = "travel_cruise"
+      TravelAndFlight = "travel_flight"
+
+      All = constants.map { |c| const_get(c) }
+    end
+
+    module AdditionalCharge
+      Restaurant = "restaurant"
+      GiftShop = "gift_shop"
+      MiniBar = "mini_bar"
+      Telephone = "telephone"
+      Laundry = "laundry"
+      Other = "other"
 
       All = constants.map { |c| const_get(c) }
     end
@@ -68,219 +84,257 @@ module Braintree
       All = constants.map { |c| const_get(c) }
     end
 
-    attr_reader :avs_error_response_code, :avs_postal_code_response_code, :avs_street_address_response_code
-    attr_reader :amount, :created_at, :credit_card_details, :customer_details, :subscription_details, :service_fee_amount, :id
+    module ExternalVault
+      module Status
+        WillVault = "will_vault"
+        Vaulted = "vaulted"
+      end
+    end
+
+    attr_reader :acquirer_reference_number
+    attr_reader :ach_return_code
+    attr_reader :add_ons
+    attr_reader :additional_processor_response          # The raw response from the processor.
+    attr_reader :amount
+    attr_reader :apple_pay_details
+    attr_reader :authorization_adjustments
+    attr_reader :authorization_expires_at
+    attr_reader :authorized_transaction_id
+    attr_reader :avs_error_response_code
+    attr_reader :avs_postal_code_response_code
+    attr_reader :avs_street_address_response_code
+    attr_reader :billing_details
+    attr_reader :channel
+    attr_reader :created_at
+    attr_reader :credit_card_details
     attr_reader :currency_iso_code
     attr_reader :custom_fields
+    attr_reader :customer_details
     attr_reader :cvv_response_code
+    attr_reader :descriptor
     attr_reader :disbursement_details
+    attr_reader :discount_amount
+    attr_reader :discounts
     attr_reader :disputes
-    attr_reader :descriptor
     attr_reader :escrow_status
+    attr_reader :facilitated_details
+    attr_reader :facilitator_details
     attr_reader :gateway_rejection_reason
+    attr_reader :google_pay_details
+    attr_reader :graphql_id
+    attr_reader :id
+    attr_reader :installment_count
+    attr_reader :installments
+    attr_reader :local_payment_details
     attr_reader :merchant_account_id
+    attr_reader :merchant_advice_code
+    attr_reader :merchant_advice_code_text
+    attr_reader :network_response_code                  # Response code from the card network
+    attr_reader :network_response_text                  # Response text from the card network
+    attr_reader :network_token_details
+    attr_reader :network_transaction_id
     attr_reader :order_id
-    attr_reader :channel
-    attr_reader :billing_details, :shipping_details
+    attr_reader :partial_settlement_transaction_ids
+    attr_reader :payment_instrument_type
     attr_reader :paypal_details
-    attr_reader :apple_pay_details
-    attr_reader :android_pay_details
-    attr_reader :amex_express_checkout_details
-    attr_reader :venmo_account_details
-    attr_reader :coinbase_details
+    attr_reader :paypal_here_details
     attr_reader :plan_id
-    # The authorization code from the processor.
-    attr_reader :processor_authorization_code
-    # The response code from the processor.
-    attr_reader :processor_response_code
-    # The response text from the processor.
-    attr_reader :processor_response_text
-    # The raw response from the processor.
-    attr_reader :additional_processor_response
-    # The settlement response code from the processor.
-    attr_reader :processor_settlement_response_code
-    # The settlement response text from the processor.
-    attr_reader :processor_settlement_response_text
-    attr_reader :voice_referral_number
+    attr_reader :processor_authorization_code           # Authorization code from the processor.
+    attr_reader :processor_response_code                # Response code from the processor.
+    attr_reader :processor_response_text                # Response text from the processor.
+    attr_reader :processor_response_type                # Response type from the processor.
+    attr_reader :processor_settlement_response_code     # Settlement response code from the processor.
+    attr_reader :processor_settlement_response_text     # Settlement response text from the processor.
+    attr_reader :product_sku
     attr_reader :purchase_order_number
     attr_reader :recurring
-    attr_reader :refund_ids, :refunded_transaction_id
+    attr_reader :refund_ids
+    attr_reader :refunded_transaction_id
+    attr_reader :refunded_installments
+    attr_reader :retried
+    attr_reader :retrieval_reference_number
+    attr_reader :risk_data
+    attr_reader :samsung_pay_card_details
+    attr_reader :sca_exemption_requested
+    attr_reader :service_fee_amount
+    attr_reader :sepa_direct_debit_account_details
+    attr_reader :sepa_direct_debit_return_code
     attr_reader :settlement_batch_id
-    attr_reader :authorized_transaction_id
-    attr_reader :partial_settlement_transaction_ids
-    # See Transaction::Status
-    attr_reader :status
+    attr_reader :shipping_amount
+    attr_reader :shipping_details
+    attr_reader :ships_from_postal_code
+    attr_reader :status                                 # See Transaction::Status
     attr_reader :status_history
+    attr_reader :subscription_details
     attr_reader :subscription_id
     attr_reader :tax_amount
     attr_reader :tax_exempt
-    # Will either be "sale" or "credit"
-    attr_reader :type
-    attr_reader :updated_at
-    attr_reader :add_ons, :discounts
-    attr_reader :payment_instrument_type
-    attr_reader :risk_data
-    attr_reader :facilitator_details
     attr_reader :three_d_secure_info
+    attr_reader :type                                   # Will either be "sale" or "credit"
+    attr_reader :updated_at
     attr_reader :us_bank_account_details
-    attr_reader :ideal_payment_details
+    attr_reader :venmo_account_details
     attr_reader :visa_checkout_card_details
-    attr_reader :masterpass_card_details
+    attr_reader :voice_referral_number
+    attr_reader :ach_return_responses
 
-    def self.create(attributes)
-      Configuration.gateway.transaction.create(attributes)
+    def self.adjust_authorization(*args)
+      Configuration.gateway.transaction.adjust_authorization(*args)
     end
 
-    def self.create!(attributes)
-      return_object_or_raise(:transaction) { create(attributes) }
+    def self.adjust_authorization!(*args)
+      Configuration.gateway.transaction.adjust_authorization!(*args)
     end
 
-    def self.cancel_release(transaction_id)
-      Configuration.gateway.transaction.cancel_release(transaction_id)
+    def self.create(*args)
+      Configuration.gateway.transaction.create(*args)
     end
 
-    def self.cancel_release!(transaction_id)
-      return_object_or_raise(:transaction) { cancel_release(transaction_id) }
+    def self.create!(*args)
+      return_object_or_raise(:transaction) { create(*args) }
     end
 
-    def self.clone_transaction(transaction_id, attributes)
-      Configuration.gateway.transaction.clone_transaction(transaction_id, attributes)
+    def self.cancel_release(*args)
+      Configuration.gateway.transaction.cancel_release(*args)
     end
 
-    def self.clone_transaction!(transaction_id, attributes)
-      return_object_or_raise(:transaction) { clone_transaction(transaction_id, attributes) }
+    def self.cancel_release!(*args)
+      Configuration.gateway.transaction.cancel_release!(*args)
     end
 
-    # Deprecated. Use Braintree::TransparentRedirect.confirm
-    def self.create_from_transparent_redirect(query_string)
-      warn "[DEPRECATED] Transaction.create_from_transparent_redirect is deprecated. Please use TransparentRedirect.confirm"
-      Configuration.gateway.transaction.create_from_transparent_redirect(query_string)
+    def self.clone_transaction(*args)
+      Configuration.gateway.transaction.clone_transaction(*args)
     end
 
-    # Deprecated. Use Braintree::TransparentRedirect.url
-    def self.create_transaction_url
-      warn "[DEPRECATED] Transaction.create_transaction_url is deprecated. Please use TransparentRedirect.url"
-      Configuration.gateway.transaction.create_transaction_url
+    def self.clone_transaction!(*args)
+      Configuration.gateway.transaction.clone_transaction!(*args)
     end
 
-    def self.credit(attributes)
-      Configuration.gateway.transaction.credit(attributes)
+    def self.credit(*args)
+      Configuration.gateway.transaction.credit(*args)
     end
 
-    def self.credit!(attributes)
-      return_object_or_raise(:transaction) { credit(attributes) }
+    def self.credit!(*args)
+      Configuration.gateway.transaction.credit!(*args)
     end
 
-    def self.find(id)
-      Configuration.gateway.transaction.find(id)
+    def self.find(*args)
+      Configuration.gateway.transaction.find(*args)
     end
 
-    def self.hold_in_escrow(id)
-      Configuration.gateway.transaction.hold_in_escrow(id)
+    def self.line_items(*args)
+      Configuration.gateway.transaction_line_item.find_all(*args)
     end
 
-    def self.hold_in_escrow!(id)
-      return_object_or_raise(:transaction) { hold_in_escrow(id) }
+    def self.hold_in_escrow(*args)
+      Configuration.gateway.transaction.hold_in_escrow(*args)
     end
 
-    def self.refund(id, amount_or_options = nil)
-      Configuration.gateway.transaction.refund(id, amount_or_options)
+    def self.hold_in_escrow!(*args)
+      Configuration.gateway.transaction.hold_in_escrow!(*args)
     end
 
-    def self.refund!(id, amount_or_options = nil)
-      return_object_or_raise(:transaction) { refund(id, amount_or_options) }
+    def self.refund(*args)
+      Configuration.gateway.transaction.refund(*args)
     end
 
-    def self.sale(attributes)
-      Configuration.gateway.transaction.sale(attributes)
+    def self.refund!(*args)
+      Configuration.gateway.transaction.refund!(*args)
     end
 
-    def self.sale!(attributes)
-      return_object_or_raise(:transaction) { sale(attributes) }
+    def self.sale(*args)
+      Configuration.gateway.transaction.sale(*args)
+    end
+
+    def self.sale!(*args)
+      Configuration.gateway.transaction.sale!(*args)
     end
 
     def self.search(&block)
       Configuration.gateway.transaction.search(&block)
     end
 
-    def self.release_from_escrow(transaction_id)
-      Configuration.gateway.transaction.release_from_escrow(transaction_id)
+    def self.release_from_escrow(*args)
+      Configuration.gateway.transaction.release_from_escrow(*args)
     end
 
-    def self.release_from_escrow!(transaction_id)
-      return_object_or_raise(:transaction) { release_from_escrow(transaction_id) }
+    def self.release_from_escrow!(*args)
+      Configuration.gateway.transaction.release_from_escrow!(*args)
     end
 
-    def self.submit_for_settlement(transaction_id, amount = nil, options = {})
-      Configuration.gateway.transaction.submit_for_settlement(transaction_id, amount, options)
+    def self.submit_for_settlement(*args)
+      Configuration.gateway.transaction.submit_for_settlement(*args)
     end
 
-    def self.submit_for_settlement!(transaction_id, amount = nil, options = {})
-      return_object_or_raise(:transaction) { submit_for_settlement(transaction_id, amount, options) }
+    def self.submit_for_settlement!(*args)
+      Configuration.gateway.transaction.submit_for_settlement!(*args)
     end
 
-    def self.update_details(transaction_id, options = {})
-      Configuration.gateway.transaction.update_details(transaction_id, options)
+    def self.update_details(*args)
+      Configuration.gateway.transaction.update_details(*args)
     end
 
-    def self.update_details!(transaction_id, options = {})
-      return_object_or_raise(:transaction) { update_details(transaction_id, options) }
+    def self.update_details!(*args)
+      return_object_or_raise(:transaction) { update_details(*args) }
     end
 
-    def self.submit_for_partial_settlement(authorized_transaction_id, amount = nil, options = {})
-      Configuration.gateway.transaction.submit_for_partial_settlement(authorized_transaction_id, amount, options)
+    def self.submit_for_partial_settlement(*args)
+      Configuration.gateway.transaction.submit_for_partial_settlement(*args)
     end
 
-    def self.submit_for_partial_settlement!(authorized_transaction_id, amount = nil, options = {})
-      return_object_or_raise(:transaction) { submit_for_partial_settlement(authorized_transaction_id, amount, options) }
+    def self.submit_for_partial_settlement!(*args)
+      Configuration.gateway.transaction.submit_for_partial_settlement!(*args)
     end
 
-    def self.void(transaction_id)
-      Configuration.gateway.transaction.void(transaction_id)
+    def self.void(*args)
+      Configuration.gateway.transaction.void(*args)
     end
 
-    def self.void!(transaction_id)
-      return_object_or_raise(:transaction) { void(transaction_id) }
+    def self.void!(*args)
+      Configuration.gateway.transaction.void!(*args)
     end
 
     def initialize(gateway, attributes) # :nodoc:
       @gateway = gateway
       set_instance_variables_from_hash(attributes)
+
       @amount = Util.to_big_decimal(amount)
+      @apple_pay_details = ApplePayDetails.new(@apple_pay)
+      @billing_details = AddressDetails.new(@billing)
       @credit_card_details = CreditCardDetails.new(@credit_card)
-      @service_fee_amount = Util.to_big_decimal(service_fee_amount)
-      @subscription_details = SubscriptionDetails.new(@subscription)
+      @network_token_details = CreditCardDetails.new(@network_token)
+      @custom_fields = attributes[:custom_fields].is_a?(Hash) ? attributes[:custom_fields] : {}
       @customer_details = CustomerDetails.new(@customer)
-      @billing_details = AddressDetails.new(@billing)
+      @descriptor = Descriptor.new(@descriptor)
       @disbursement_details = DisbursementDetails.new(@disbursement_details)
+      @google_pay_details = GooglePayDetails.new(@google_pay_card)
+      @local_payment_details = LocalPaymentDetails.new(@local_payment)
+      @payment_instrument_type = attributes[:payment_instrument_type]
+      @paypal_details = PayPalDetails.new(@paypal)
+      @paypal_here_details = PayPalHereDetails.new(@paypal_here)
+      @samsung_pay_card_details = SamsungPayCardDetails.new(attributes[:samsung_pay_card])
+      @sca_exemption_requested = attributes[:sca_exemption_requested]
+      @sepa_direct_debit_account_details = SepaDirectDebitAccountDetails.new(@sepa_debit_account_detail)
+      @service_fee_amount = Util.to_big_decimal(service_fee_amount)
       @shipping_details = AddressDetails.new(@shipping)
       @status_history = attributes[:status_history] ? attributes[:status_history].map { |s| StatusDetails.new(s) } : []
+      @subscription_details = SubscriptionDetails.new(@subscription)
       @tax_amount = Util.to_big_decimal(tax_amount)
-      @descriptor = Descriptor.new(@descriptor)
-      @paypal_details = PayPalDetails.new(@paypal)
-      @apple_pay_details = ApplePayDetails.new(@apple_pay)
-      @android_pay_details = AndroidPayDetails.new(@android_pay_card)
-      @amex_express_checkout_details = AmexExpressCheckoutDetails.new(@amex_express_checkout_card)
       @venmo_account_details = VenmoAccountDetails.new(@venmo_account)
-      @coinbase_details = CoinbaseDetails.new(@coinbase_account)
-      disputes.map! { |attrs| Dispute._new(attrs) } if disputes
-      @custom_fields = attributes[:custom_fields].is_a?(Hash) ? attributes[:custom_fields] : {}
-      add_ons.map! { |attrs| AddOn._new(attrs) } if add_ons
-      discounts.map! { |attrs| Discount._new(attrs) } if discounts
-      @payment_instrument_type = attributes[:payment_instrument_type]
-      @risk_data = RiskData.new(attributes[:risk_data]) if attributes[:risk_data]
+      @visa_checkout_card_details = VisaCheckoutCardDetails.new(attributes[:visa_checkout_card])
+
+      @facilitated_details = FacilitatedDetails.new(attributes[:facilitated_details]) if attributes[:facilitated_details]
       @facilitator_details = FacilitatorDetails.new(attributes[:facilitator_details]) if attributes[:facilitator_details]
+      @risk_data = RiskData.new(attributes[:risk_data]) if attributes[:risk_data]
       @three_d_secure_info = ThreeDSecureInfo.new(attributes[:three_d_secure_info]) if attributes[:three_d_secure_info]
       @us_bank_account_details = UsBankAccountDetails.new(attributes[:us_bank_account]) if attributes[:us_bank_account]
-      @ideal_payment_details = IdealPaymentDetails.new(attributes[:ideal_payment]) if attributes[:ideal_payment]
-      @visa_checkout_card_details = VisaCheckoutCardDetails.new(attributes[:visa_checkout_card])
-      @masterpass_card_details = MasterpassCardDetails.new(attributes[:masterpass_card])
-    end
 
-    # True if <tt>other</tt> is a Braintree::Transaction with the same id.
-    def ==(other)
-      return false unless other.is_a?(Transaction)
-      id == other.id
+      add_ons.map! { |attrs| AddOn._new(attrs) } if add_ons
+      authorization_adjustments.map! { |attrs| AuthorizationAdjustment._new(attrs) } if authorization_adjustments
+      discounts.map! { |attrs| Discount._new(attrs) } if discounts
+      disputes.map! { |attrs| Dispute._new(attrs) } if disputes
+      installments.map! { |attrs| Installment.new(attrs) } if installments
+      refunded_installments.map! { |attrs| Installment.new(attrs) } if refunded_installments
     end
 
     def inspect # :nodoc:
@@ -296,16 +350,8 @@ module Braintree
       "#<#{self.class} #{nice_attributes.join(', ')}>"
     end
 
-    # Deprecated. Use Braintree::Transaction.refund
-    def refund(amount = nil)
-      warn "[DEPRECATED] refund as an instance method is deprecated. Please use Transaction.refund"
-      result = @gateway.transaction.refund(id, amount)
-
-      if result.success?
-        SuccessfulResult.new(:new_transaction => result.transaction)
-      else
-        result
-      end
+    def line_items
+      @gateway.transaction_line_item.find_all(id)
     end
 
     # Returns true if the transaction has been refunded. False otherwise.
@@ -318,27 +364,6 @@ module Braintree
       @disbursement_details.valid?
     end
 
-    def refund_id
-      warn "[DEPRECATED] Transaction.refund_id is deprecated. Please use Transaction.refund_ids"
-      @refund_id
-    end
-
-    # Deprecated. Use Braintree::Transaction.submit_for_settlement
-    def submit_for_settlement(amount = nil)
-      warn "[DEPRECATED] submit_for_settlement as an instance method is deprecated. Please use Transaction.submit_for_settlement"
-      result = @gateway.transaction.submit_for_settlement(id, amount)
-      if result.success?
-        copy_instance_variables_from_object result.transaction
-      end
-      result
-    end
-
-    # Deprecated. Use Braintree::Transaction.submit_for_settlement!
-    def submit_for_settlement!(amount = nil)
-      warn "[DEPRECATED] submit_for_settlement! as an instance method is deprecated. Please use Transaction.submit_for_settlement!"
-      return_object_or_raise(:transaction) { submit_for_settlement(amount) }
-    end
-
     # If this transaction was stored in the vault, or created from vault records,
     # vault_billing_address will return the associated Braintree::Address. Because the
     # vault billing address can be updated after the transaction was created, the attributes
@@ -375,31 +400,19 @@ module Braintree
       @gateway.address.find(customer_details.id, shipping_details.id)
     end
 
-    # Deprecated. Use Braintree::Transaction.void
-    def void
-      warn "[DEPRECATED] void as an instance method is deprecated. Please use Transaction.void"
-      result = @gateway.transaction.void(id)
-      if result.success?
-        copy_instance_variables_from_object result.transaction
-      end
-      result
-    end
-
-    # Deprecated. Use Braintree::Transaction.void!
-    def void!
-      warn "[DEPRECATED] void! as an instance method is deprecated. Please use Transaction.void!"
-      return_object_or_raise(:transaction) { void }
+    def processed_with_network_token?
+      @processed_with_network_token
     end
 
     class << self
       protected :new
       def _new(*args) # :nodoc:
-        self.new *args
+        self.new(*args)
       end
     end
 
     def self._attributes # :nodoc:
-      [:amount, :created_at, :credit_card_details, :customer_details, :id, :status, :subscription_details, :type, :updated_at]
+      [:amount, :created_at, :credit_card_details, :customer_details, :id, :status, :subscription_details, :type, :updated_at, :processed_with_network_token?]
     end
   end
 end