braintree 4.24.0 → 4.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d1f769a1e530039399adceb1214c04b7050dd00ab43943dfc15e267907be9bc
-  data.tar.gz: dab377d31b453bbfc98fe210704e309f83628d8eef18f6458f04101bcf7f7407
+  metadata.gz: ca8e969e0988757df5800a440fdc36293b48bc0c72cc8c56b1175d74d79f309b
+  data.tar.gz: b44530a7eb4a73728fd4c79292633fc7d7ca0d6476c26b7277c1a3051d29fcaa
 SHA512:
-  metadata.gz: ab3bf0f9dd88d510a99094899535a8505ac0532fc6bc74ab2fefaa0c02f56910bc25a85d7faebc212a4260b256b8fa2e70fd69336eb9647a46621bfaaadd8581
-  data.tar.gz: ed8a75dd5a0826383440975466f966b7c0ffd232b778499c2de28ac330defd6eb53390873a63e25e89869c2a609626010f9db13cfbd55e3ce8f189e9e7c223e9
+  metadata.gz: 2d985f754fa864774601dad717587b5d5d7f1e75a9579286100559e9cd4ab1819fd856b5c90c6d59870149b6d7bfd0cc5d2865f2d96362a208c037854b9ab312
+  data.tar.gz: 2ab4e8c0f48d76e10f4854e3e32fe55c154c8bdd40730625409f4259921268788c9bd2baf3152724a6d665ed5d0bf53dc7b540570f2f9777ced5dc53be6aeaa8

data/lib/braintree/apple_pay_card.rb

@@ -32,6 +32,7 @@ module Braintree
     attr_reader :payment_instrument_name
     attr_reader :payroll
     attr_reader :prepaid
+    attr_reader :prepaid_reloadable
     attr_reader :product_id
     attr_reader :source_card_last4
     attr_reader :source_description

data/lib/braintree/bin_data.rb

@@ -10,6 +10,7 @@ module Braintree
     attr_reader :issuing_bank
     attr_reader :payroll
     attr_reader :prepaid
+    attr_reader :prepaid_reloadable
     attr_reader :product_id
 
     def initialize(attributes)
@@ -26,7 +27,7 @@ module Braintree
     def self._attributes
       [
         :commercial, :country_of_issuance, :debit, :durbin_regulated, :healthcare,
-        :issuing_bank, :payroll, :prepaid, :product_id
+        :issuing_bank, :payroll, :prepaid, :prepaid_reloadable, :product_id
       ]
     end
   end

data/lib/braintree/credit_card.rb

@@ -45,8 +45,8 @@ module Braintree
       Unknown = "Unknown"
     end
 
-    Commercial = Debit = DurbinRegulated = Healthcare = Payroll = Prepaid = ProductId =
-      IssuingBank = CountryOfIssuance = CardTypeIndicator
+    Commercial = CountryOfIssuance = Debit = DurbinRegulated = Healthcare =
+      IssuingBank = Payroll = Prepaid = PrepaidReloadable = ProductId = CardTypeIndicator
 
     attr_reader :billing_address
     attr_reader :bin
@@ -66,6 +66,7 @@ module Braintree
     attr_reader :last_4
     attr_reader :payroll
     attr_reader :prepaid
+    attr_reader :prepaid_reloadable
     attr_reader :product_id
     attr_reader :subscriptions
     attr_reader :token
@@ -199,9 +200,9 @@ module Braintree
 
     def self._attributes
       [
-        :billing_address, :bin, :card_type, :cardholder_name, :created_at, :customer_id, :expiration_month,
-        :expiration_year, :last_4, :token, :updated_at, :prepaid, :payroll, :product_id, :commercial, :debit, :durbin_regulated,
-        :healthcare, :country_of_issuance, :issuing_bank, :image_url, :is_network_tokenized?
+        :billing_address, :bin, :card_type, :cardholder_name, :commercial, :country_of_issuance, :created_at, :customer_id,
+        :debit, :durbin_regulated, :expiration_month, :expiration_year, :healthcare, :image_url, :is_network_tokenized?,
+        :issuing_bank, :last_4, :payroll, :prepaid, :prepaid_reloadable, :product_id, :token, :updated_at
       ]
     end
 

data/lib/braintree/customer_session_gateway.rb

@@ -0,0 +1,194 @@
+# Creates and manages PayPal customer sessions.
+
+module Braintree
+    class CustomerSessionGateway
+      CREATE_CUSTOMER_SESSION = <<~GRAPHQL
+        mutation CreateCustomerSession($input: CreateCustomerSessionInput!) {
+          createCustomerSession(input: $input) {
+            sessionId
+          }
+        }
+      GRAPHQL
+
+      UPDATE_CUSTOMER_SESSION = <<~GRAPHQL
+        mutation UpdateCustomerSession($input: UpdateCustomerSessionInput!) {
+          updateCustomerSession(input: $input) {
+            sessionId
+          }
+        }
+      GRAPHQL
+
+      GET_CUSTOMER_RECOMMENDATIONS = <<~GRAPHQL
+        query CustomerRecommendations($input: CustomerRecommendationsInput!) {
+          customerRecommendations(input: $input) {
+            isInPayPalNetwork
+            recommendations {
+              ... on PaymentRecommendations {
+                paymentOptions {
+                  paymentOption
+                  recommendedPriority
+                }
+              }
+            }
+          }
+        }
+      GRAPHQL
+
+      def initialize(gateway, graphql_client)
+        @gateway = gateway
+        @graphql_client = graphql_client
+      end
+
+      # Creates a new customer session.
+      #
+      # Example:
+      #   customer = {
+      #    email: "test@example.com",
+      #    device_fingerprint_id: "1234",
+      #    phone: {country_phone_code: "1", phone_number: "5555555555"},
+      #    paypal_app_installed: true,
+      #    venmo_app_installed: true,
+      #   }
+      #   input = Braintree::CreateCustomerSessionInput.new(
+      #                customer: customer,
+      #   )
+      #   result = gateway.customer_session.create_customer_session(input)
+      #   if result.success?
+      #     puts "Created session #{result.session_id}"
+      #   else
+      #     puts "Validations failed"
+      #     puts result.errors.first.message
+      #   end
+      #
+      # @param input [CreateCustomerSessionInput] The input parameters for creating a customer session.
+      #
+      # @return [(Successful|Error)Result] A result object with session ID if successful, or errors otherwise.
+      #
+      # @raise [UnexpectedError] If there is an unexpected error during the process.
+      def create_customer_session(input)
+        execute_mutation(CREATE_CUSTOMER_SESSION, input, :createCustomerSession)
+      end
+
+
+      # Updates an existing customer session.
+      #
+      # Example:
+      #   customer = {
+      #    email: "test@example.com",
+      #    device_fingerprint_id: "1234",
+      #    phone: {country_phone_code: "1", phone_number: "5555555555"},
+      #    paypal_app_installed: true,
+      #    venmo_app_installed: true,
+      #   }
+      #   input = Braintree::UpdateCustomerSessionInput.new(
+      #                session_id: "11EF-34BC-2702904B-9026-555555555555",
+      #                customer: customer,
+      #   )
+      #   result = gateway.customer_session.updated_customer_session(input)
+      #   if result.success?
+      #     puts "Updated session #{result.session_id}"
+      #   else
+      #     puts "Validations failed"
+      #     puts result.errors.first.message
+      #   end
+      #
+      # @param input [UpdateCustomerSessionInput] The input parameters for updating a customer session.
+      #
+      # @return [(Successful|Error)Result] A result object with session ID if successful, or errors otherwise.
+      #
+      # @raise [UnexpectedError] If there is an unexpected error during the process.
+      def update_customer_session(input)
+        execute_mutation(UPDATE_CUSTOMER_SESSION, input, :updateCustomerSession)
+      end
+
+      # Retrieves customer recommendations associated with a customer session.
+      #
+      # Example:
+      #   customer = {
+      #    email: "test@example.com",
+      #    device_fingerprint_id: "1234",
+      #    phone: {country_phone_code: "1", phone_number: "5555555555"},
+      #    paypal_app_installed: true,
+      #    venmo_app_installed: true,
+      #   }
+      #   input = Braintree::CustomerRecommendationsInput.new(
+      #                session_id: "11EF-34BC-2702904B-9026-555555555555",
+      #                customer: customer,
+      #                recommendations: [Braintree::Recommendations::PAYMENT_RECOMMENDATIONS]
+      #   )
+      #   result = gateway.customer_session.get_customer_recommendations(input)
+      #   if result.success?
+      #     puts "Fetched customer recommendations"
+      #     payload = result.customer_recommendations
+      #     puts payload
+      #   else
+      #     puts "Validations failed"
+      #     puts result.errors.first.message
+      #   end
+      #
+      # @param input [CustomerRecommendationsInput] The input parameters for retrieving customer recommendations.
+      #
+      # @return [Result\Error|Result\Successful] A result object containing the customer recommendations if successful, or errors otherwise.
+      #
+      # @raise [UnexpectedError] If there is an unexpected error during the process.
+      def get_customer_recommendations(customer_recommendations_input)
+        variables = {"input" => customer_recommendations_input.to_graphql_variables}
+
+        begin
+          response = @graphql_client.query(GET_CUSTOMER_RECOMMENDATIONS, variables)
+          errors = GraphQLClient.get_validation_errors(response)
+          if errors
+            ErrorResult.new(@gateway, {errors:errors})
+          else
+            SuccessfulResult.new(:customer_recommendations => extract_customer_recommendations_payload(response))
+          end
+        rescue StandardError => e
+          raise UnexpectedError, e.message
+        end
+      end
+
+      private
+
+      def execute_mutation(query, input, operation_name)
+        variables = {"input" => input.to_graphql_variables}
+        begin
+          response = @graphql_client.query(query, variables)
+          errors = GraphQLClient.get_validation_errors(response)
+          if errors
+            ErrorResult.new(@gateway, {errors:errors})
+          else
+            session_id = get_value(response, "data.#{operation_name}.sessionId")
+            SuccessfulResult.new(:session_id => session_id)
+          end
+        rescue StandardError => e
+          raise UnexpectedError, e.message
+        end
+      end
+
+      def get_value(response, key)
+        map = response
+        key_parts = key.split(".")
+
+        key_parts[0..-2].each do |sub_key|
+          map = pop_value(map, sub_key)
+          raise UnexpectedError, "Couldn't parse response"  unless map.is_a?(Hash)
+        end
+
+        pop_value(map, key_parts.last)
+      end
+
+      def pop_value(map, key)
+        key = key.to_sym
+        if map.key?(key)
+          map[key]
+        else
+          raise UnexpectedError, "Couldn't parse response"
+        end
+      end
+
+      def extract_customer_recommendations_payload(data)
+        customer_recommendations_hash = get_value(data, "data.customerRecommendations")
+        Braintree::CustomerRecommendationsPayload._new(customer_recommendations_hash)
+      end
+    end
+  end

data/lib/braintree/error_codes.rb

@@ -210,6 +210,47 @@ module Braintree
       TokenIsInUse = "92906"
     end
 
+    module PayPalPaymentResource
+      NonceExpired = "97301"
+      IdNotSupported = "97302"
+      NonceRequired = "97303"
+      InvalidEmail = "97304"
+      EmailTooLong = "97305"
+      ExpectedLineItemCollection = "97306"
+      ExpectedLineItemHash = "97307"
+      ExpectedLineItemDebit = "97308"
+      InvalidUnitAmount = "97309"
+      InvalidUnitTaxAmount = "97310"
+      IsoCodeRequired = "97311"
+      IsoCodeUnsupported = "97312"
+      ShippingFieldsMissing = "97313"
+      InvalidAmountBreakdown = "97314"
+      ExpectedShippingOptionCollection = "97315"
+      ShippingOptionsRequired = "97316"
+      ShippingOptionFieldsMissing = "97317"
+      InvalidShippingOptionType = "97318"
+      ShippingOptionIdReused = "97319"
+      TooManyShippingOptionsSelected = "97320"
+      ShippingOptionMustMatchBreakdown = "97321"
+      LineItemsShouldMatchTotal = "97322"
+      LineItemsTaxShouldMatchTotal = "97323"
+      PatchCallFailed = "97324"
+      InvalidAmount = "97325"
+      ShippingIdTooLong = "97326"
+      ShippingLabelTooLong = "97327"
+      ShippingFullNameTooLong = "97328"
+      ShippingAddressTooLong = "97329"
+      ShippingExtendedAddressTooLong = "97330"
+      ShippingLocalityTooLong = "97331"
+      ShippingRegionTooLong = "97332"
+      CountryCodeTooLong = "97333"
+      NationalNumberTooLong = "97334"
+      PostalCodeTooLong = "97335"
+      DescriptionTooLong = "97336"
+      CustomFieldTooLong = "97337"
+      OrderIdTooLong = "97338"
+    end
+
     module SepaDirectDebitAccount
       SepaDebitAccountPaymentMethodMandateTypeIsNotSupported = "87115"
       SepaDebitAccountPaymentMethodCustomerIdIsInvalid = "87116"

data/lib/braintree/error_result.rb

@@ -12,7 +12,7 @@ module Braintree
 
     def initialize(gateway, data)
       @gateway = gateway
-      @params = data[:params]
+      @params = data[:params] if data[:params]
       @credit_card_verification = CreditCardVerification._new(data[:verification]) if data[:verification]
       @merchant_account = MerchantAccount._new(gateway, data[:merchant_account]) if data[:merchant_account]
       @message = data[:message]

data/lib/braintree/errors.rb

@@ -3,7 +3,8 @@ module Braintree
     include Enumerable
 
     def initialize(data = {})
-      @errors = ValidationErrorCollection.new(data.merge(:errors => []))
+      data = data.merge(:errors => []) unless data
+      @errors = ValidationErrorCollection.new(data)
     end
 
     def each(&block)

data/lib/braintree/gateway.rb

@@ -38,6 +38,10 @@ module Braintree
       CustomerGateway.new(self)
     end
 
+    def customer_session
+      CustomerSessionGateway.new(self, graphql_client)
+    end
+
     def discount
       DiscountGateway.new(self)
     end
@@ -74,6 +78,10 @@ module Braintree
       PayPalAccountGateway.new(self)
     end
 
+    def paypal_payment_resource
+      PayPalPaymentResourceGateway.new(self)
+    end
+
     def us_bank_account
       UsBankAccountGateway.new(self)
     end

data/lib/braintree/google_pay_card.rb

@@ -18,6 +18,7 @@ module Braintree
     attr_reader :issuing_bank
     attr_reader :payroll
     attr_reader :prepaid
+    attr_reader :prepaid_reloadable
     attr_reader :product_id
     attr_reader :source_card_last_4
     attr_reader :source_card_type

data/lib/braintree/graphql/enums/recommendations.rb

@@ -0,0 +1,7 @@
+# Represents available types of customer recommendations that can be retrieved using a PayPal customer session.
+
+module Braintree
+  module Recommendations
+    PAYMENT_RECOMMENDATIONS = "PAYMENT_RECOMMENDATIONS"
+  end
+end

data/lib/braintree/graphql/enums/recommended_payment_option.rb

@@ -0,0 +1,8 @@
+# Represents available payment options related to PayPal customer session recommendations.
+
+module Braintree
+  module RecommendedPaymentOption
+    PAYPAL = "PAYPAL"
+    VENMO = "VENMO"
+  end
+end

data/lib/braintree/graphql/inputs/create_customer_session_input.rb

@@ -0,0 +1,35 @@
+# Represents the input to request the creation of a PayPal customer session.
+
+module Braintree
+    class CreateCustomerSessionInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :merchant_account_id
+        attr_reader :session_id
+        attr_reader :customer
+        attr_reader :domain
+
+        def initialize(attributes)
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+            @customer = attributes[:customer] ? CustomerSessionInput.new(attributes[:customer]) : nil
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["merchantAccountId"] = merchant_account_id if merchant_account_id
+            variables["sessionId"] = session_id if session_id
+            variables["domain"] = domain if domain
+            variables["customer"] = customer.to_graphql_variables if customer
+            variables
+        end
+    end
+end
+
+

data/lib/braintree/graphql/inputs/customer_recommendations_input.rb

@@ -0,0 +1,41 @@
+# Represents the input to request PayPal customer session recommendations.
+
+module Braintree
+    class CustomerRecommendationsInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :merchant_account_id
+        attr_reader :session_id
+        attr_reader :recommendations
+        attr_reader :customer
+
+        def initialize(attributes)
+            unless attributes[:session_id]
+                raise ArgumentError, "Expected hash to contain a :session_id"
+            end
+            unless attributes[:recommendations]
+                raise ArgumentError, "Expected hash to contain a :recommendations"
+            end
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+            @customer = attributes[:customer] ? CustomerSessionInput.new(attributes[:customer]) : nil
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["merchantAccountId"] = merchant_account_id if merchant_account_id
+            variables["sessionId"] = session_id if session_id
+            variables["recommendations"] = recommendations if recommendations
+            variables["customer"] = customer.to_graphql_variables if customer
+            variables
+        end
+    end
+end
+
+

data/lib/braintree/graphql/inputs/customer_session_input.rb

@@ -0,0 +1,39 @@
+# Customer identifying information for a PayPal customer session.
+
+module Braintree
+    class CustomerSessionInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :email
+        attr_reader :phone
+        attr_reader :device_fingerprint_id
+        attr_reader :paypal_app_installed
+        attr_reader :venmo_app_installed
+        attr_reader :user_agent
+
+        def initialize(attributes)
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+            @phone = attributes[:phone] ? PhoneInput.new(attributes[:phone]) : nil
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["email"] = email if email
+            variables["phone"] = phone.to_graphql_variables if phone
+            variables["deviceFingerprintId"] = device_fingerprint_id if device_fingerprint_id
+            variables["paypalAppInstalled"] = paypal_app_installed if paypal_app_installed
+            variables["venmoAppInstalled"] = venmo_app_installed if venmo_app_installed
+            variables["userAgent"] = user_agent if user_agent
+            variables
+        end
+    end
+end
+
+

data/lib/braintree/graphql/inputs/phone_input.rb

@@ -0,0 +1,32 @@
+# Phone number input for PayPal customer session.
+
+module Braintree
+    class PhoneInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :country_phone_code
+        attr_reader :phone_number
+        attr_reader :extension_number
+
+        def initialize(attributes)
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["countryPhoneCode"] = country_phone_code if country_phone_code
+            variables["phoneNumber"] = phone_number if phone_number
+            variables["extensionNumber"] = extension_number if extension_number
+            variables
+        end
+    end
+end
+
+

data/lib/braintree/graphql/inputs/update_customer_session_input.rb

@@ -0,0 +1,37 @@
+# Represents the input to request an update to a PayPal customer session.
+
+module Braintree
+    class UpdateCustomerSessionInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :merchant_account_id
+        attr_reader :session_id
+        attr_reader :customer
+
+        def initialize(attributes)
+            unless attributes[:session_id]
+                raise ArgumentError, "Expected hash to contain a :session_id"
+            end
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+            @customer = attributes[:customer] ? CustomerSessionInput.new(attributes[:customer]) : nil
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["merchantAccountId"] = merchant_account_id if merchant_account_id
+            variables["sessionId"] = session_id if session_id
+            variables["customer"] = customer.to_graphql_variables if customer
+            variables
+        end
+
+    end
+end
+
+

data/lib/braintree/graphql/types/customer_recommendations_payload.rb

@@ -0,0 +1,32 @@
+# Represents the customer recommendations information associated with a PayPal customer session.
+
+module Braintree
+    class CustomerRecommendationsPayload
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :is_in_paypal_network
+        attr_reader :recommendations
+
+        def initialize(attributes)
+            @attrs = [:is_in_paypal_network, :recommendations]
+            @is_in_paypal_network = attributes[:isInPayPalNetwork] if attributes[:isInPayPalNetwork]
+            @recommendations = CustomerRecommendations._new(attributes[:recommendations]) if attributes[:recommendations]
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        class << self
+            protected :new
+        end
+
+        def self._new(*args)
+            self.new(*args)
+        end
+    end
+end
+
+

data/lib/braintree/graphql/types/payment_options.rb

@@ -0,0 +1,33 @@
+# Represents the payment method and priority associated with a PayPal customer session.
+
+module Braintree
+    class PaymentOptions
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :payment_option
+        attr_reader :recommended_priority
+
+        def initialize(attributes)
+            @attrs = [:payment_option, :recommended_priority]
+            @payment_option = attributes[:paymentOption] if attributes[:paymentOption]
+            @recommended_priority = attributes[:recommendedPriority] if attributes[:recommendedPriority]
+
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        class << self
+            protected :new
+        end
+
+        def self._new(*args)
+            self.new(*args)
+        end
+    end
+end
+
+

data/lib/braintree/graphql/unions/customer_recommendations.rb

@@ -0,0 +1,34 @@
+# A union of all possible customer recommendations associated with a PayPal customer session.
+
+module Braintree
+    class CustomerRecommendations
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :payment_options
+
+        def initialize(attributes)
+            @attrs = [:payment_options]
+            if attributes.nil?
+                @payment_options = []
+            else
+                @payment_options = (attributes[:paymentOptions] || []).map { |payment_options_hash| PaymentOptions._new(payment_options_hash) }
+            end
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        class << self
+            protected :new
+        end
+
+        def self._new(*args)
+            self.new(*args)
+        end
+    end
+end
+
+