processout 2.25.0 → 2.27.1

data/lib/processout/invoice.rb

@@ -48,9 +48,11 @@ module ProcessOut
     attr_reader :incremental
     attr_reader :tax
     attr_reader :payment_type
+    attr_reader :native_apm
     attr_reader :initiation_type
     attr_reader :payment_intent
     attr_reader :billing
+    attr_reader :unsupported_feature_bypass
 
     
     def id=(val)
@@ -349,6 +351,22 @@ module ProcessOut
       @payment_type = val
     end
     
+    def native_apm=(val)
+      if val.nil?
+        @native_apm = val
+        return
+      end
+
+      if val.instance_of? NativeAPMRequest
+        @native_apm = val
+      else
+        obj = NativeAPMRequest.new(@client)
+        obj.fill_with_data(val)
+        @native_apm = obj
+      end
+      
+    end
+    
     def initiation_type=(val)
       @initiation_type = val
     end
@@ -373,6 +391,22 @@ module ProcessOut
       
     end
     
+    def unsupported_feature_bypass=(val)
+      if val.nil?
+        @unsupported_feature_bypass = val
+        return
+      end
+
+      if val.instance_of? UnsupportedFeatureBypass
+        @unsupported_feature_bypass = val
+      else
+        obj = UnsupportedFeatureBypass.new(@client)
+        obj.fill_with_data(val)
+        @unsupported_feature_bypass = obj
+      end
+      
+    end
+    
 
     # Initializes the Invoice object
     # Params:
@@ -421,9 +455,11 @@ module ProcessOut
       self.incremental = data.fetch(:incremental, nil)
       self.tax = data.fetch(:tax, nil)
       self.payment_type = data.fetch(:payment_type, nil)
+      self.native_apm = data.fetch(:native_apm, nil)
       self.initiation_type = data.fetch(:initiation_type, nil)
       self.payment_intent = data.fetch(:payment_intent, nil)
       self.billing = data.fetch(:billing, nil)
+      self.unsupported_feature_bypass = data.fetch(:unsupported_feature_bypass, nil)
       
     end
 
@@ -475,9 +511,11 @@ module ProcessOut
           "incremental": self.incremental,
           "tax": self.tax,
           "payment_type": self.payment_type,
+          "native_apm": self.native_apm,
           "initiation_type": self.initiation_type,
           "payment_intent": self.payment_intent,
           "billing": self.billing,
+          "unsupported_feature_bypass": self.unsupported_feature_bypass,
       }.to_json
     end
 
@@ -608,6 +646,9 @@ module ProcessOut
       if data.include? "payment_type"
         self.payment_type = data["payment_type"]
       end
+      if data.include? "native_apm"
+        self.native_apm = data["native_apm"]
+      end
       if data.include? "initiation_type"
         self.initiation_type = data["initiation_type"]
       end
@@ -617,6 +658,9 @@ module ProcessOut
       if data.include? "billing"
         self.billing = data["billing"]
       end
+      if data.include? "unsupported_feature_bypass"
+        self.unsupported_feature_bypass = data["unsupported_feature_bypass"]
+      end
       
       self
     end
@@ -668,9 +712,11 @@ module ProcessOut
       self.incremental = data.fetch(:incremental, self.incremental)
       self.tax = data.fetch(:tax, self.tax)
       self.payment_type = data.fetch(:payment_type, self.payment_type)
+      self.native_apm = data.fetch(:native_apm, self.native_apm)
       self.initiation_type = data.fetch(:initiation_type, self.initiation_type)
       self.payment_intent = data.fetch(:payment_intent, self.payment_intent)
       self.billing = data.fetch(:billing, self.billing)
+      self.unsupported_feature_bypass = data.fetch(:unsupported_feature_bypass, self.unsupported_feature_bypass)
       
       self
     end
@@ -821,6 +867,85 @@ module ProcessOut
       return_values[0]
     end
 
+    # Process the payout invoice using the given source (customer or token)
+    # Params:
+    # +gateway_configuration_id+:: ID of the configuration, that processes payout
+    # +source+:: Source used to process the payout. Can be a card, a token or a gateway request
+    # +options+:: +Hash+ of options
+    def payout(gateway_configuration_id, source, options = {})
+      self.prefill(options)
+
+      request = Request.new(@client)
+      path    = "/invoices/" + CGI.escape(@id) + "/payout"
+      data    = {
+        "force_gateway_configuration_id" => options.fetch(:force_gateway_configuration_id, nil), 
+        "gateway_configuration_id" => gateway_configuration_id, 
+        "source" => source
+      }
+
+      response = Response.new(request.post(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["transaction"]
+      transaction = Transaction.new(@client)
+      return_values.push(transaction.fill_with_data(body))
+
+      
+      return_values[0]
+    end
+
+    # Fetches the Native APM payment
+    # Params:
+    # +invoice_id+:: ID of the invoice
+    # +gateway_configuration_id+:: ID of the native APM configuration
+    # +options+:: +Hash+ of options
+    def show_native_payment_transaction(invoice_id, gateway_configuration_id, options = {})
+      self.prefill(options)
+
+      request = Request.new(@client)
+      path    = "/invoices/" + CGI.escape(invoice_id) + "/native-payment/" + CGI.escape(gateway_configuration_id) + ""
+      data    = {
+
+      }
+
+      response = Response.new(request.get(path, data, options))
+      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))
+
+      
+      return_values[0]
+    end
+
+    # Process the Native APM payment flow
+    # Params:
+    # +invoice_id+:: ID of the invoice
+    # +options+:: +Hash+ of options
+    def process_native_payment(invoice_id, options = {})
+      self.prefill(options)
+
+      request = Request.new(@client)
+      path    = "/invoices/" + CGI.escape(invoice_id) + "/native-payment"
+      data    = {
+        "gateway_configuration_id" => options.fetch(:gateway_configuration_id, nil), 
+        "native_apm" => options.fetch(:native_apm, nil)
+      }
+
+      response = Response.new(request.post(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      invoices_process_native_payment_response = InvoicesProcessNativePaymentResponse.new(@client)
+      return_values.push(invoices_process_native_payment_response.fill_with_data(body))
+
+      
+      return_values[0]
+    end
+
     # Initiate a 3-D Secure authentication
     # Params:
     # +source+:: Source used to initiate the 3-D Secure authentication. Can be a card, or a token representing a card
@@ -963,7 +1088,8 @@ module ProcessOut
         "external_fraud_tools" => @external_fraud_tools, 
         "tax" => @tax, 
         "payment_type" => @payment_type, 
-        "billing" => @billing
+        "billing" => @billing, 
+        "unsupported_feature_bypass" => @unsupported_feature_bypass
       }
 
       response = Response.new(request.post(path, data, options))

data/lib/processout/invoice_external_fraud_tools.rb

@@ -9,6 +9,7 @@ module ProcessOut
   class InvoiceExternalFraudTools
     
     attr_reader :forter
+    attr_reader :ravelin
     attr_reader :signifyd
 
     
@@ -16,6 +17,10 @@ module ProcessOut
       @forter = val
     end
     
+    def ravelin=(val)
+      @ravelin = val
+    end
+    
     def signifyd=(val)
       @signifyd = val
     end
@@ -29,6 +34,7 @@ module ProcessOut
       @client = client
 
       self.forter = data.fetch(:forter, nil)
+      self.ravelin = data.fetch(:ravelin, nil)
       self.signifyd = data.fetch(:signifyd, nil)
       
     end
@@ -42,6 +48,7 @@ module ProcessOut
     def to_json(options)
       {
           "forter": self.forter,
+          "ravelin": self.ravelin,
           "signifyd": self.signifyd,
       }.to_json
     end
@@ -56,6 +63,9 @@ module ProcessOut
       if data.include? "forter"
         self.forter = data["forter"]
       end
+      if data.include? "ravelin"
+        self.ravelin = data["ravelin"]
+      end
       if data.include? "signifyd"
         self.signifyd = data["signifyd"]
       end
@@ -71,6 +81,7 @@ module ProcessOut
         return self
       end
       self.forter = data.fetch(:forter, self.forter)
+      self.ravelin = data.fetch(:ravelin, self.ravelin)
       self.signifyd = data.fetch(:signifyd, self.signifyd)
       
       self

data/lib/processout/invoice_risk.rb

@@ -10,6 +10,7 @@ module ProcessOut
     
     attr_reader :score
     attr_reader :is_legit
+    attr_reader :skip_gateway_rules
 
     
     def score=(val)
@@ -20,6 +21,10 @@ module ProcessOut
       @is_legit = val
     end
     
+    def skip_gateway_rules=(val)
+      @skip_gateway_rules = val
+    end
+    
 
     # Initializes the InvoiceRisk object
     # Params:
@@ -30,6 +35,7 @@ module ProcessOut
 
       self.score = data.fetch(:score, nil)
       self.is_legit = data.fetch(:is_legit, nil)
+      self.skip_gateway_rules = data.fetch(:skip_gateway_rules, nil)
       
     end
 
@@ -43,6 +49,7 @@ module ProcessOut
       {
           "score": self.score,
           "is_legit": self.is_legit,
+          "skip_gateway_rules": self.skip_gateway_rules,
       }.to_json
     end
 
@@ -59,6 +66,9 @@ module ProcessOut
       if data.include? "is_legit"
         self.is_legit = data["is_legit"]
       end
+      if data.include? "skip_gateway_rules"
+        self.skip_gateway_rules = data["skip_gateway_rules"]
+      end
       
       self
     end
@@ -72,6 +82,7 @@ module ProcessOut
       end
       self.score = data.fetch(:score, self.score)
       self.is_legit = data.fetch(:is_legit, self.is_legit)
+      self.skip_gateway_rules = data.fetch(:skip_gateway_rules, self.skip_gateway_rules)
       
       self
     end

data/lib/processout/invoice_shipping.rb

@@ -19,6 +19,7 @@ module ProcessOut
     attr_reader :country_code
     attr_reader :zip
     attr_reader :phone_number
+    attr_reader :phone
     attr_reader :expects_shipping_at
     attr_reader :relay_store_name
 
@@ -67,6 +68,22 @@ module ProcessOut
       @phone_number = val
     end
     
+    def phone=(val)
+      if val.nil?
+        @phone = val
+        return
+      end
+
+      if val.instance_of? InvoiceShippingPhone
+        @phone = val
+      else
+        obj = InvoiceShippingPhone.new(@client)
+        obj.fill_with_data(val)
+        @phone = obj
+      end
+      
+    end
+    
     def expects_shipping_at=(val)
       @expects_shipping_at = val
     end
@@ -94,6 +111,7 @@ module ProcessOut
       self.country_code = data.fetch(:country_code, nil)
       self.zip = data.fetch(:zip, nil)
       self.phone_number = data.fetch(:phone_number, nil)
+      self.phone = data.fetch(:phone, nil)
       self.expects_shipping_at = data.fetch(:expects_shipping_at, nil)
       self.relay_store_name = data.fetch(:relay_store_name, nil)
       
@@ -118,6 +136,7 @@ module ProcessOut
           "country_code": self.country_code,
           "zip": self.zip,
           "phone_number": self.phone_number,
+          "phone": self.phone,
           "expects_shipping_at": self.expects_shipping_at,
           "relay_store_name": self.relay_store_name,
       }.to_json
@@ -163,6 +182,9 @@ module ProcessOut
       if data.include? "phone_number"
         self.phone_number = data["phone_number"]
       end
+      if data.include? "phone"
+        self.phone = data["phone"]
+      end
       if data.include? "expects_shipping_at"
         self.expects_shipping_at = data["expects_shipping_at"]
       end
@@ -191,6 +213,7 @@ module ProcessOut
       self.country_code = data.fetch(:country_code, self.country_code)
       self.zip = data.fetch(:zip, self.zip)
       self.phone_number = data.fetch(:phone_number, self.phone_number)
+      self.phone = data.fetch(:phone, self.phone)
       self.expects_shipping_at = data.fetch(:expects_shipping_at, self.expects_shipping_at)
       self.relay_store_name = data.fetch(:relay_store_name, self.relay_store_name)
       

data/lib/processout/invoice_shipping_phone.rb

@@ -0,0 +1,81 @@
+# The content of this file was automatically generated
+
+require "cgi"
+require "json"
+require "processout/networking/request"
+require "processout/networking/response"
+
+module ProcessOut
+  class InvoiceShippingPhone
+    
+    attr_reader :number
+    attr_reader :dialing_code
+
+    
+    def number=(val)
+      @number = val
+    end
+    
+    def dialing_code=(val)
+      @dialing_code = val
+    end
+    
+
+    # Initializes the InvoiceShippingPhone object
+    # Params:
+    # +client+:: +ProcessOut+ client instance
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
+      @client = client
+
+      self.number = data.fetch(:number, nil)
+      self.dialing_code = data.fetch(:dialing_code, nil)
+      
+    end
+
+    # Create a new InvoiceShippingPhone using the current client
+    def new(data = {})
+      InvoiceShippingPhone.new(@client, data)
+    end
+
+    # Overrides the JSON marshaller to only send the fields we want
+    def to_json(options)
+      {
+          "number": self.number,
+          "dialing_code": self.dialing_code,
+      }.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? "number"
+        self.number = data["number"]
+      end
+      if data.include? "dialing_code"
+        self.dialing_code = data["dialing_code"]
+      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.number = data.fetch(:number, self.number)
+      self.dialing_code = data.fetch(:dialing_code, self.dialing_code)
+      
+      self
+    end
+
+    
+  end
+end

data/lib/processout/invoices_process_native_payment_response.rb

@@ -0,0 +1,105 @@
+# The content of this file was automatically generated
+
+require "cgi"
+require "json"
+require "processout/networking/request"
+require "processout/networking/response"
+
+module ProcessOut
+  class InvoicesProcessNativePaymentResponse
+    
+    attr_reader :transaction
+    attr_reader :native_apm
+
+    
+    def transaction=(val)
+      if val.nil?
+        @transaction = val
+        return
+      end
+
+      if val.instance_of? Transaction
+        @transaction = val
+      else
+        obj = Transaction.new(@client)
+        obj.fill_with_data(val)
+        @transaction = obj
+      end
+      
+    end
+    
+    def native_apm=(val)
+      if val.nil?
+        @native_apm = val
+        return
+      end
+
+      if val.instance_of? NativeAPMResponse
+        @native_apm = val
+      else
+        obj = NativeAPMResponse.new(@client)
+        obj.fill_with_data(val)
+        @native_apm = obj
+      end
+      
+    end
+    
+
+    # Initializes the InvoicesProcessNativePaymentResponse object
+    # Params:
+    # +client+:: +ProcessOut+ client instance
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
+      @client = client
+
+      self.transaction = data.fetch(:transaction, nil)
+      self.native_apm = data.fetch(:native_apm, nil)
+      
+    end
+
+    # Create a new InvoicesProcessNativePaymentResponse using the current client
+    def new(data = {})
+      InvoicesProcessNativePaymentResponse.new(@client, data)
+    end
+
+    # Overrides the JSON marshaller to only send the fields we want
+    def to_json(options)
+      {
+          "transaction": self.transaction,
+          "native_apm": self.native_apm,
+      }.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? "transaction"
+        self.transaction = data["transaction"]
+      end
+      if data.include? "native_apm"
+        self.native_apm = data["native_apm"]
+      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.transaction = data.fetch(:transaction, self.transaction)
+      self.native_apm = data.fetch(:native_apm, self.native_apm)
+      
+      self
+    end
+
+    
+  end
+end

data/lib/processout/native_apm_parameter_definition.rb

@@ -0,0 +1,141 @@
+# The content of this file was automatically generated
+
+require "cgi"
+require "json"
+require "processout/networking/request"
+require "processout/networking/response"
+
+module ProcessOut
+  class NativeAPMParameterDefinition
+    
+    attr_reader :key
+    attr_reader :type
+    attr_reader :required
+    attr_reader :length
+    attr_reader :display_name
+    attr_reader :available_values
+
+    
+    def key=(val)
+      @key = val
+    end
+    
+    def type=(val)
+      @type = val
+    end
+    
+    def required=(val)
+      @required = val
+    end
+    
+    def length=(val)
+      @length = val
+    end
+    
+    def display_name=(val)
+      @display_name = val
+    end
+    
+    def available_values=(val)
+      if val.nil?
+        @available_values = []
+        return
+      end
+
+      if val.length > 0 and val[0].instance_of? NativeAPMParameterValueDefinition
+        @available_values = val
+      else
+        l = Array.new
+        for v in val
+          obj = NativeAPMParameterValueDefinition.new(@client)
+          obj.fill_with_data(v)
+          l.push(obj)
+        end
+        @available_values = l
+      end
+      
+    end
+    
+
+    # Initializes the NativeAPMParameterDefinition object
+    # Params:
+    # +client+:: +ProcessOut+ client instance
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
+      @client = client
+
+      self.key = data.fetch(:key, nil)
+      self.type = data.fetch(:type, nil)
+      self.required = data.fetch(:required, nil)
+      self.length = data.fetch(:length, nil)
+      self.display_name = data.fetch(:display_name, nil)
+      self.available_values = data.fetch(:available_values, nil)
+      
+    end
+
+    # Create a new NativeAPMParameterDefinition using the current client
+    def new(data = {})
+      NativeAPMParameterDefinition.new(@client, data)
+    end
+
+    # Overrides the JSON marshaller to only send the fields we want
+    def to_json(options)
+      {
+          "key": self.key,
+          "type": self.type,
+          "required": self.required,
+          "length": self.length,
+          "display_name": self.display_name,
+          "available_values": self.available_values,
+      }.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? "key"
+        self.key = data["key"]
+      end
+      if data.include? "type"
+        self.type = data["type"]
+      end
+      if data.include? "required"
+        self.required = data["required"]
+      end
+      if data.include? "length"
+        self.length = data["length"]
+      end
+      if data.include? "display_name"
+        self.display_name = data["display_name"]
+      end
+      if data.include? "available_values"
+        self.available_values = data["available_values"]
+      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.key = data.fetch(:key, self.key)
+      self.type = data.fetch(:type, self.type)
+      self.required = data.fetch(:required, self.required)
+      self.length = data.fetch(:length, self.length)
+      self.display_name = data.fetch(:display_name, self.display_name)
+      self.available_values = data.fetch(:available_values, self.available_values)
+      
+      self
+    end
+
+    
+  end
+end