processout 3.4.0 → 6.0.0

data/lib/processout/invoice.rb

@@ -15,12 +15,11 @@ module ProcessOut
     attr_reader :transaction_id
     attr_reader :customer
     attr_reader :customer_id
-    attr_reader :subscription
-    attr_reader :subscription_id
     attr_reader :token
     attr_reader :token_id
     attr_reader :details
     attr_reader :submerchant
+    attr_reader :submerchant_id
     attr_reader :url
     attr_reader :url_qrcode
     attr_reader :name
@@ -60,6 +59,7 @@ module ProcessOut
     attr_reader :verification
     attr_reader :auto_capture_at
     attr_reader :reference_id
+    attr_reader :payment_processing_config
 
     
     def id=(val)
@@ -126,26 +126,6 @@ module ProcessOut
       @customer_id = val
     end
     
-    def subscription=(val)
-      if val.nil?
-        @subscription = val
-        return
-      end
-
-      if val.instance_of? Subscription
-        @subscription = val
-      else
-        obj = Subscription.new(@client)
-        obj.fill_with_data(val)
-        @subscription = obj
-      end
-      
-    end
-    
-    def subscription_id=(val)
-      @subscription_id = val
-    end
-    
     def token=(val)
       if val.nil?
         @token = val
@@ -202,6 +182,10 @@ module ProcessOut
       
     end
     
+    def submerchant_id=(val)
+      @submerchant_id = val
+    end
+    
     def url=(val)
       @url = val
     end
@@ -454,6 +438,22 @@ module ProcessOut
       @reference_id = val
     end
     
+    def payment_processing_config=(val)
+      if val.nil?
+        @payment_processing_config = val
+        return
+      end
+
+      if val.instance_of? PaymentProcessingConfiguration
+        @payment_processing_config = val
+      else
+        obj = PaymentProcessingConfiguration.new(@client)
+        obj.fill_with_data(val)
+        @payment_processing_config = obj
+      end
+      
+    end
+    
 
     # Initializes the Invoice object
     # Params:
@@ -469,12 +469,11 @@ module ProcessOut
       self.transaction_id = data.fetch(:transaction_id, nil)
       self.customer = data.fetch(:customer, nil)
       self.customer_id = data.fetch(:customer_id, nil)
-      self.subscription = data.fetch(:subscription, nil)
-      self.subscription_id = data.fetch(:subscription_id, nil)
       self.token = data.fetch(:token, nil)
       self.token_id = data.fetch(:token_id, nil)
       self.details = data.fetch(:details, nil)
       self.submerchant = data.fetch(:submerchant, nil)
+      self.submerchant_id = data.fetch(:submerchant_id, nil)
       self.url = data.fetch(:url, nil)
       self.url_qrcode = data.fetch(:url_qrcode, nil)
       self.name = data.fetch(:name, nil)
@@ -514,6 +513,7 @@ module ProcessOut
       self.verification = data.fetch(:verification, nil)
       self.auto_capture_at = data.fetch(:auto_capture_at, nil)
       self.reference_id = data.fetch(:reference_id, nil)
+      self.payment_processing_config = data.fetch(:payment_processing_config, nil)
       
     end
 
@@ -532,12 +532,11 @@ module ProcessOut
           "transaction_id": self.transaction_id,
           "customer": self.customer,
           "customer_id": self.customer_id,
-          "subscription": self.subscription,
-          "subscription_id": self.subscription_id,
           "token": self.token,
           "token_id": self.token_id,
           "details": self.details,
           "submerchant": self.submerchant,
+          "submerchant_id": self.submerchant_id,
           "url": self.url,
           "url_qrcode": self.url_qrcode,
           "name": self.name,
@@ -577,6 +576,7 @@ module ProcessOut
           "verification": self.verification,
           "auto_capture_at": self.auto_capture_at,
           "reference_id": self.reference_id,
+          "payment_processing_config": self.payment_processing_config,
       }.to_json
     end
 
@@ -608,12 +608,6 @@ module ProcessOut
       if data.include? "customer_id"
         self.customer_id = data["customer_id"]
       end
-      if data.include? "subscription"
-        self.subscription = data["subscription"]
-      end
-      if data.include? "subscription_id"
-        self.subscription_id = data["subscription_id"]
-      end
       if data.include? "token"
         self.token = data["token"]
       end
@@ -626,6 +620,9 @@ module ProcessOut
       if data.include? "submerchant"
         self.submerchant = data["submerchant"]
       end
+      if data.include? "submerchant_id"
+        self.submerchant_id = data["submerchant_id"]
+      end
       if data.include? "url"
         self.url = data["url"]
       end
@@ -743,6 +740,9 @@ module ProcessOut
       if data.include? "reference_id"
         self.reference_id = data["reference_id"]
       end
+      if data.include? "payment_processing_config"
+        self.payment_processing_config = data["payment_processing_config"]
+      end
       
       self
     end
@@ -761,12 +761,11 @@ module ProcessOut
       self.transaction_id = data.fetch(:transaction_id, self.transaction_id)
       self.customer = data.fetch(:customer, self.customer)
       self.customer_id = data.fetch(:customer_id, self.customer_id)
-      self.subscription = data.fetch(:subscription, self.subscription)
-      self.subscription_id = data.fetch(:subscription_id, self.subscription_id)
       self.token = data.fetch(:token, self.token)
       self.token_id = data.fetch(:token_id, self.token_id)
       self.details = data.fetch(:details, self.details)
       self.submerchant = data.fetch(:submerchant, self.submerchant)
+      self.submerchant_id = data.fetch(:submerchant_id, self.submerchant_id)
       self.url = data.fetch(:url, self.url)
       self.url_qrcode = data.fetch(:url_qrcode, self.url_qrcode)
       self.name = data.fetch(:name, self.name)
@@ -806,10 +805,59 @@ module ProcessOut
       self.verification = data.fetch(:verification, self.verification)
       self.auto_capture_at = data.fetch(:auto_capture_at, self.auto_capture_at)
       self.reference_id = data.fetch(:reference_id, self.reference_id)
+      self.payment_processing_config = data.fetch(:payment_processing_config, self.payment_processing_config)
       
       self
     end
 
+    # Autheticate the invoice using the given source (customer or token)
+    # Params:
+    # +source+:: Source used to authenticate the payment. Can be a card, token or a gateway request.
+    # +options+:: +Hash+ of options
+    def authenticate(source, options = {})
+      self.prefill(options)
+
+      request = Request.new(@client)
+      path    = "/invoices/:invoice_id/authenticate"
+      data    = {
+        "device" => @device, 
+        "incremental" => @incremental, 
+        "synchronous" => options.fetch(:synchronous, nil), 
+        "retry_drop_liability_shift" => options.fetch(:retry_drop_liability_shift, nil), 
+        "capture_amount" => options.fetch(:capture_amount, nil), 
+        "enable_three_d_s_2" => options.fetch(:enable_three_d_s_2, nil), 
+        "allow_fallback_to_sale" => options.fetch(:allow_fallback_to_sale, nil), 
+        "auto_capture_at" => options.fetch(:auto_capture_at, nil), 
+        "metadata" => options.fetch(:metadata, nil), 
+        "override_mac_blocking" => options.fetch(:override_mac_blocking, nil), 
+        "external_three_d_s" => options.fetch(:external_three_d_s, nil), 
+        "save_source" => options.fetch(:save_source, nil), 
+        "provision_network_token" => options.fetch(:provision_network_token, nil), 
+        "invoice_line_items" => options.fetch(:invoice_line_items, nil), 
+        "transaction_link_id" => options.fetch(:transaction_link_id, nil), 
+        "source" => source
+      }
+
+      response = Response.new(request.post(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body.key?("transaction") ? body["transaction"] : nil
+      if !body.nil?
+        transaction = Transaction.new(@client)
+        return_values.push(transaction.fill_with_data(body))
+      end
+      body = response.body
+      body = body.key?("customer_action") ? body["customer_action"] : nil
+      if !body.nil?
+        customer_action = CustomerAction.new(@client)
+        return_values.push(customer_action.fill_with_data(body))
+      end
+
+      
+      return_values
+    end
+
     # Create an incremental authorization
     # Params:
     # +amount+:: Amount to increment authorization by
@@ -828,9 +876,11 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["transaction"]
-      transaction = Transaction.new(@client)
-      return_values.push(transaction.fill_with_data(body))
+      body = body.key?("transaction") ? body["transaction"] : nil
+      if !body.nil?
+        transaction = Transaction.new(@client)
+        return_values.push(transaction.fill_with_data(body))
+      end
 
       
       return_values[0]
@@ -858,6 +908,9 @@ module ProcessOut
         "override_mac_blocking" => options.fetch(:override_mac_blocking, nil), 
         "external_three_d_s" => options.fetch(:external_three_d_s, nil), 
         "save_source" => options.fetch(:save_source, nil), 
+        "provision_network_token" => options.fetch(:provision_network_token, nil), 
+        "invoice_line_items" => options.fetch(:invoice_line_items, nil), 
+        "transaction_link_id" => options.fetch(:transaction_link_id, nil), 
         "source" => source
       }
 
@@ -865,13 +918,17 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["transaction"]
-      transaction = Transaction.new(@client)
-      return_values.push(transaction.fill_with_data(body))
+      body = body.key?("transaction") ? body["transaction"] : nil
+      if !body.nil?
+        transaction = Transaction.new(@client)
+        return_values.push(transaction.fill_with_data(body))
+      end
       body = response.body
-      body = body["customer_action"]
-      customer_action = CustomerAction.new(@client)
-      return_values.push(customer_action.fill_with_data(body))
+      body = body.key?("customer_action") ? body["customer_action"] : nil
+      if !body.nil?
+        customer_action = CustomerAction.new(@client)
+        return_values.push(customer_action.fill_with_data(body))
+      end
 
       
       return_values
@@ -900,6 +957,8 @@ module ProcessOut
         "override_mac_blocking" => options.fetch(:override_mac_blocking, nil), 
         "external_three_d_s" => options.fetch(:external_three_d_s, nil), 
         "save_source" => options.fetch(:save_source, nil), 
+        "provision_network_token" => options.fetch(:provision_network_token, nil), 
+        "transaction_link_id" => options.fetch(:transaction_link_id, nil), 
         "source" => source
       }
 
@@ -907,13 +966,17 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["transaction"]
-      transaction = Transaction.new(@client)
-      return_values.push(transaction.fill_with_data(body))
+      body = body.key?("transaction") ? body["transaction"] : nil
+      if !body.nil?
+        transaction = Transaction.new(@client)
+        return_values.push(transaction.fill_with_data(body))
+      end
       body = response.body
-      body = body["customer_action"]
-      customer_action = CustomerAction.new(@client)
-      return_values.push(customer_action.fill_with_data(body))
+      body = body.key?("customer_action") ? body["customer_action"] : nil
+      if !body.nil?
+        customer_action = CustomerAction.new(@client)
+        return_values.push(customer_action.fill_with_data(body))
+      end
 
       
       return_values
@@ -935,9 +998,11 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["customer"]
-      customer = Customer.new(@client)
-      return_values.push(customer.fill_with_data(body))
+      body = body.key?("customer") ? body["customer"] : nil
+      if !body.nil?
+        customer = Customer.new(@client)
+        return_values.push(customer.fill_with_data(body))
+      end
 
       
       return_values[0]
@@ -960,9 +1025,11 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["customer"]
-      customer = Customer.new(@client)
-      return_values.push(customer.fill_with_data(body))
+      body = body.key?("customer") ? body["customer"] : nil
+      if !body.nil?
+        customer = Customer.new(@client)
+        return_values.push(customer.fill_with_data(body))
+      end
 
       
       return_values[0]
@@ -980,6 +1047,7 @@ module ProcessOut
       path    = "/invoices/" + CGI.escape(@id) + "/payout"
       data    = {
         "force_gateway_configuration_id" => options.fetch(:force_gateway_configuration_id, nil), 
+        "metadata" => options.fetch(:metadata, nil), 
         "gateway_configuration_id" => gateway_configuration_id, 
         "source" => source
       }
@@ -988,9 +1056,11 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["transaction"]
-      transaction = Transaction.new(@client)
-      return_values.push(transaction.fill_with_data(body))
+      body = body.key?("transaction") ? body["transaction"] : nil
+      if !body.nil?
+        transaction = Transaction.new(@client)
+        return_values.push(transaction.fill_with_data(body))
+      end
 
       
       return_values[0]
@@ -1014,9 +1084,11 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["native_apm"]
-      native_apm_transaction_details = NativeAPMTransactionDetails.new(@client)
-      return_values.push(native_apm_transaction_details.fill_with_data(body))
+      body = body.key?("native_apm") ? body["native_apm"] : nil
+      if !body.nil?
+        native_apm_transaction_details = NativeAPMTransactionDetails.new(@client)
+        return_values.push(native_apm_transaction_details.fill_with_data(body))
+      end
 
       
       return_values[0]
@@ -1040,13 +1112,17 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["transaction"]
-      transaction = Transaction.new(@client)
-      return_values.push(transaction.fill_with_data(body))
+      body = body.key?("transaction") ? body["transaction"] : nil
+      if !body.nil?
+        transaction = Transaction.new(@client)
+        return_values.push(transaction.fill_with_data(body))
+      end
       body = response.body
-      body = body["native_apm"]
-      native_apm_response = NativeAPMResponse.new(@client)
-      return_values.push(native_apm_response.fill_with_data(body))
+      body = body.key?("native_apm") ? body["native_apm"] : nil
+      if !body.nil?
+        native_apm_response = NativeAPMResponse.new(@client)
+        return_values.push(native_apm_response.fill_with_data(body))
+      end
 
       
       return_values
@@ -1070,9 +1146,11 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["customer_action"]
-      customer_action = CustomerAction.new(@client)
-      return_values.push(customer_action.fill_with_data(body))
+      body = body.key?("customer_action") ? body["customer_action"] : nil
+      if !body.nil?
+        customer_action = CustomerAction.new(@client)
+        return_values.push(customer_action.fill_with_data(body))
+      end
 
       
       return_values[0]
@@ -1094,9 +1172,11 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["transaction"]
-      transaction = Transaction.new(@client)
-      return_values.push(transaction.fill_with_data(body))
+      body = body.key?("transaction") ? body["transaction"] : nil
+      if !body.nil?
+        transaction = Transaction.new(@client)
+        return_values.push(transaction.fill_with_data(body))
+      end
 
       
       return_values[0]
@@ -1119,9 +1199,11 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["transaction"]
-      transaction = Transaction.new(@client)
-      return_values.push(transaction.fill_with_data(body))
+      body = body.key?("transaction") ? body["transaction"] : nil
+      if !body.nil?
+        transaction = Transaction.new(@client)
+        return_values.push(transaction.fill_with_data(body))
+      end
 
       
       return_values[0]
@@ -1174,6 +1256,7 @@ module ProcessOut
         "metadata" => @metadata, 
         "details" => @details, 
         "submerchant" => @submerchant, 
+        "submerchant_id" => @submerchant_id, 
         "reference_id" => @reference_id, 
         "exemption_reason_3ds2" => @exemption_reason_3ds2, 
         "sca_exemption_reason" => @sca_exemption_reason, 
@@ -1208,7 +1291,7 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["invoice"]
+      body = body.key?("invoice") ? body["invoice"] : nil
       
       
       return_values.push(self.fill_with_data(body))
@@ -1235,7 +1318,7 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["invoice"]
+      body = body.key?("invoice") ? body["invoice"] : nil
       
       
       obj = Invoice.new(@client)
@@ -1285,7 +1368,7 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["invoice"]
+      body = body.key?("invoice") ? body["invoice"] : nil
       
       
       obj = Invoice.new(@client)
@@ -1316,7 +1399,7 @@ module ProcessOut
       return_values = Array.new
       
       body = response.body
-      body = body["invoice"]
+      body = body.key?("invoice") ? body["invoice"] : nil
       
       
       return_values.push(self.fill_with_data(body))

data/lib/processout/invoice_device.rb

@@ -9,6 +9,7 @@ module ProcessOut
   class InvoiceDevice
     
     attr_reader :channel
+    attr_reader :platform
     attr_reader :ip_address
     attr_reader :id
 
@@ -17,6 +18,10 @@ module ProcessOut
       @channel = val
     end
     
+    def platform=(val)
+      @platform = val
+    end
+    
     def ip_address=(val)
       @ip_address = val
     end
@@ -34,6 +39,7 @@ module ProcessOut
       @client = client
 
       self.channel = data.fetch(:channel, nil)
+      self.platform = data.fetch(:platform, nil)
       self.ip_address = data.fetch(:ip_address, nil)
       self.id = data.fetch(:id, nil)
       
@@ -48,6 +54,7 @@ module ProcessOut
     def to_json(options)
       {
           "channel": self.channel,
+          "platform": self.platform,
           "ip_address": self.ip_address,
           "id": self.id,
       }.to_json
@@ -63,6 +70,9 @@ module ProcessOut
       if data.include? "channel"
         self.channel = data["channel"]
       end
+      if data.include? "platform"
+        self.platform = data["platform"]
+      end
       if data.include? "ip_address"
         self.ip_address = data["ip_address"]
       end
@@ -81,6 +91,7 @@ module ProcessOut
         return self
       end
       self.channel = data.fetch(:channel, self.channel)
+      self.platform = data.fetch(:platform, self.platform)
       self.ip_address = data.fetch(:ip_address, self.ip_address)
       self.id = data.fetch(:id, self.id)
       

data/lib/processout/invoice_external_fraud_tools.rb

@@ -11,6 +11,7 @@ module ProcessOut
     attr_reader :forter
     attr_reader :ravelin
     attr_reader :signifyd
+    attr_reader :riskified
 
     
     def forter=(val)
@@ -28,6 +29,11 @@ module ProcessOut
       
     end
     
+    def riskified=(val)
+      @riskified = val
+      
+    end
+    
 
     # Initializes the InvoiceExternalFraudTools object
     # Params:
@@ -39,6 +45,7 @@ module ProcessOut
       self.forter = data.fetch(:forter, nil)
       self.ravelin = data.fetch(:ravelin, nil)
       self.signifyd = data.fetch(:signifyd, nil)
+      self.riskified = data.fetch(:riskified, nil)
       
     end
 
@@ -53,6 +60,7 @@ module ProcessOut
           "forter": self.forter,
           "ravelin": self.ravelin,
           "signifyd": self.signifyd,
+          "riskified": self.riskified,
       }.to_json
     end
 
@@ -72,6 +80,9 @@ module ProcessOut
       if data.include? "signifyd"
         self.signifyd = data["signifyd"]
       end
+      if data.include? "riskified"
+        self.riskified = data["riskified"]
+      end
       
       self
     end
@@ -86,6 +97,7 @@ module ProcessOut
       self.forter = data.fetch(:forter, self.forter)
       self.ravelin = data.fetch(:ravelin, self.ravelin)
       self.signifyd = data.fetch(:signifyd, self.signifyd)
+      self.riskified = data.fetch(:riskified, self.riskified)
       
       self
     end

data/lib/processout/networking/request.rb

@@ -13,7 +13,7 @@ module ProcessOut
       req.basic_auth @client.project_id, @client.project_secret
       req.content_type = "application/json"
       req["API-Version"] = "1.4.0.0"
-      req["User-Agent"] = "ProcessOut Ruby-Bindings/3.4.0"
+      req["User-Agent"] = "ProcessOut Ruby-Bindings/6.0.0"
 
       unless options.nil?
         req["Idempotency-Key"] = options.fetch(:idempotency_key, "")

data/lib/processout/payment_processing_configuration.rb

@@ -0,0 +1,93 @@
+# The content of this file was automatically generated
+
+require "cgi"
+require "json"
+require "processout/networking/request"
+require "processout/networking/response"
+
+module ProcessOut
+  class PaymentProcessingConfiguration
+    
+    attr_reader :bypass_unsupported_split_payments
+    attr_reader :apm_payment_config
+
+    
+    def bypass_unsupported_split_payments=(val)
+      @bypass_unsupported_split_payments = val
+    end
+    
+    def apm_payment_config=(val)
+      if val.nil?
+        @apm_payment_config = val
+        return
+      end
+
+      if val.instance_of? APMPaymentProcessingConfiguration
+        @apm_payment_config = val
+      else
+        obj = APMPaymentProcessingConfiguration.new(@client)
+        obj.fill_with_data(val)
+        @apm_payment_config = obj
+      end
+      
+    end
+    
+
+    # Initializes the PaymentProcessingConfiguration object
+    # Params:
+    # +client+:: +ProcessOut+ client instance
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
+      @client = client
+
+      self.bypass_unsupported_split_payments = data.fetch(:bypass_unsupported_split_payments, nil)
+      self.apm_payment_config = data.fetch(:apm_payment_config, nil)
+      
+    end
+
+    # Create a new PaymentProcessingConfiguration using the current client
+    def new(data = {})
+      PaymentProcessingConfiguration.new(@client, data)
+    end
+
+    # Overrides the JSON marshaller to only send the fields we want
+    def to_json(options)
+      {
+          "bypass_unsupported_split_payments": self.bypass_unsupported_split_payments,
+          "apm_payment_config": self.apm_payment_config,
+      }.to_json
+    end
+
+    # Fills the object with data coming from the API
+    # Params:
+    # +data+:: +Hash+ of data coming from the API
+    def fill_with_data(data)
+      if data.nil?
+        return self
+      end
+      if data.include? "bypass_unsupported_split_payments"
+        self.bypass_unsupported_split_payments = data["bypass_unsupported_split_payments"]
+      end
+      if data.include? "apm_payment_config"
+        self.apm_payment_config = data["apm_payment_config"]
+      end
+      
+      self
+    end
+
+    # Prefills the object with the data passed as parameters
+    # Params:
+    # +data+:: +Hash+ of data
+    def prefill(data)
+      if data.nil?
+        return self
+      end
+      self.bypass_unsupported_split_payments = data.fetch(:bypass_unsupported_split_payments, self.bypass_unsupported_split_payments)
+      self.apm_payment_config = data.fetch(:apm_payment_config, self.apm_payment_config)
+      
+      self
+    end
+
+    
+  end
+end