hamza-payments-query-sdk 1.0.0

data/lib/payments/models/device_data.rb

@@ -0,0 +1,200 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object containing device data for 3DS & Fraud assessment.
+  class DeviceData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Used by the issuer to check if the customer's browser is compatible with
+    # the issuer 3DS challenge display.
+    # @return [String]
+    attr_accessor :accept_header
+
+    # Used by issuers as part of risk analysis and correctly displaying the
+    # challenge. Must conform to RFC 7321.
+    # @return [String]
+    attr_accessor :user_agent_header
+
+    # Your customer's browser language that can be used by the issuer in risk
+    # analysis. Must conform to the language tags defined by IETF. E.g. en-GB,
+    # fr-FR.
+    # @return [String]
+    attr_accessor :browser_language
+
+    # Defines whether Java is enabled on your customers browser.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :browser_java_enabled
+
+    # The color depth of your customers browser
+    # @return [BrowserColorDepthEnum]
+    attr_accessor :browser_color_depth
+
+    # Defines the pixel height of the customers browser.
+    # @return [Integer]
+    attr_accessor :browser_screen_height
+
+    # Defines the pixel width of the customers browser.
+    # @return [Integer]
+    attr_accessor :browser_screen_width
+
+    # Time zone offset in minutes between UTC and your customer's browser local
+    # time.  
+    # Example time zone offset values in minutes:  
+    # If UTC -5 hours:  
+    # `300`  
+    # `+300`  
+    # If UTC +5 hours:  
+    # `-300`
+    # @return [String]
+    attr_accessor :time_zone
+
+    # Defines whether Javascript is enabled on your customers browser.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :browser_javascript_enabled
+
+    # Determines the channel that the transaction came through. `native` should
+    # only be set if using the Cardinal 3DS SDK (iOS/Android)
+    # @return [ChannelEnum]
+    attr_accessor :channel
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accept_header'] = 'acceptHeader'
+      @_hash['user_agent_header'] = 'userAgentHeader'
+      @_hash['browser_language'] = 'browserLanguage'
+      @_hash['browser_java_enabled'] = 'browserJavaEnabled'
+      @_hash['browser_color_depth'] = 'browserColorDepth'
+      @_hash['browser_screen_height'] = 'browserScreenHeight'
+      @_hash['browser_screen_width'] = 'browserScreenWidth'
+      @_hash['time_zone'] = 'timeZone'
+      @_hash['browser_javascript_enabled'] = 'browserJavascriptEnabled'
+      @_hash['channel'] = 'channel'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        browser_language
+        browser_java_enabled
+        browser_color_depth
+        browser_screen_height
+        browser_screen_width
+        time_zone
+        browser_javascript_enabled
+        channel
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accept_header = nil, user_agent_header = nil,
+                   browser_language = SKIP, browser_java_enabled = SKIP,
+                   browser_color_depth = SKIP, browser_screen_height = SKIP,
+                   browser_screen_width = SKIP, time_zone = SKIP,
+                   browser_javascript_enabled = SKIP, channel = SKIP)
+      @accept_header = accept_header
+      @user_agent_header = user_agent_header
+      @browser_language = browser_language unless browser_language == SKIP
+      @browser_java_enabled = browser_java_enabled unless browser_java_enabled == SKIP
+      @browser_color_depth = browser_color_depth unless browser_color_depth == SKIP
+      @browser_screen_height = browser_screen_height unless browser_screen_height == SKIP
+      @browser_screen_width = browser_screen_width unless browser_screen_width == SKIP
+      @time_zone = time_zone unless time_zone == SKIP
+      unless browser_javascript_enabled == SKIP
+        @browser_javascript_enabled =
+          browser_javascript_enabled
+      end
+      @channel = channel unless channel == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      accept_header = hash.key?('acceptHeader') ? hash['acceptHeader'] : nil
+      user_agent_header =
+        hash.key?('userAgentHeader') ? hash['userAgentHeader'] : nil
+      browser_language =
+        hash.key?('browserLanguage') ? hash['browserLanguage'] : SKIP
+      browser_java_enabled =
+        hash.key?('browserJavaEnabled') ? hash['browserJavaEnabled'] : SKIP
+      browser_color_depth =
+        hash.key?('browserColorDepth') ? hash['browserColorDepth'] : SKIP
+      browser_screen_height = Number.from_hash(hash['browserScreenHeight']) if
+        hash['browserScreenHeight']
+      browser_screen_width = Number.from_hash(hash['browserScreenWidth']) if
+        hash['browserScreenWidth']
+      time_zone = hash.key?('timeZone') ? hash['timeZone'] : SKIP
+      browser_javascript_enabled =
+        hash.key?('browserJavascriptEnabled') ? hash['browserJavascriptEnabled'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+
+      # Create object from extracted values.
+      DeviceData.new(accept_header,
+                     user_agent_header,
+                     browser_language,
+                     browser_java_enabled,
+                     browser_color_depth,
+                     browser_screen_height,
+                     browser_screen_width,
+                     time_zone,
+                     browser_javascript_enabled,
+                     channel)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DeviceData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.accept_header,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.user_agent_header,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['acceptHeader'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['userAgentHeader'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} accept_header: #{@accept_header}, user_agent_header: #{@user_agent_header},"\
+      " browser_language: #{@browser_language}, browser_java_enabled: #{@browser_java_enabled},"\
+      " browser_color_depth: #{@browser_color_depth}, browser_screen_height:"\
+      " #{@browser_screen_height}, browser_screen_width: #{@browser_screen_width}, time_zone:"\
+      " #{@time_zone}, browser_javascript_enabled: #{@browser_javascript_enabled}, channel:"\
+      " #{@channel}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} accept_header: #{@accept_header.inspect}, user_agent_header:"\
+      " #{@user_agent_header.inspect}, browser_language: #{@browser_language.inspect},"\
+      " browser_java_enabled: #{@browser_java_enabled.inspect}, browser_color_depth:"\
+      " #{@browser_color_depth.inspect}, browser_screen_height: #{@browser_screen_height.inspect},"\
+      " browser_screen_width: #{@browser_screen_width.inspect}, time_zone: #{@time_zone.inspect},"\
+      " browser_javascript_enabled: #{@browser_javascript_enabled.inspect}, channel:"\
+      " #{@channel.inspect}>"
+    end
+  end
+end

data/lib/payments/models/device_data_collection.rb

@@ -0,0 +1,79 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # DeviceDataCollection Model.
+  class DeviceDataCollection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A digitally signed token that contains additional details required for
+    # DDC.
+    # @return [String]
+    attr_accessor :jwt
+
+    # A `POST` action on the DDC form. Used to redirect to the issuers DDC page.
+    # This URL can could change so should not be hardcoded.
+    # @return [String]
+    attr_accessor :url
+
+    # First six digits of the card number (Bank Identification Number), used as
+    # part of DDC.
+    # @return [String]
+    attr_accessor :bin
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['jwt'] = 'jwt'
+      @_hash['url'] = 'url'
+      @_hash['bin'] = 'bin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(jwt = nil, url = nil, bin = nil)
+      @jwt = jwt
+      @url = url
+      @bin = bin
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      jwt = hash.key?('jwt') ? hash['jwt'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+      bin = hash.key?('bin') ? hash['bin'] : nil
+
+      # Create object from extracted values.
+      DeviceDataCollection.new(jwt,
+                               url,
+                               bin)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} jwt: #{@jwt}, url: #{@url}, bin: #{@bin}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} jwt: #{@jwt.inspect}, url: #{@url.inspect}, bin: #{@bin.inspect}>"
+    end
+  end
+end

data/lib/payments/models/device_data_request.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # DeviceDataRequest Model.
+  class DeviceDataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Add the `sessionId` provided in the [postMessage for the device data
+    # collection form
+    # (web)](/products/payments/enable-features/3ds-authentication/web) or for
+    # native (iOS/Android), returned as `consumerSessionId` as part of [SDK
+    # initialization](/products/payments/enable-features/3ds-authentication/andr
+    # oid-ios). <br><br>__Note:__ If device data collection fails you can
+    # attempt the payment without this value, but you will see an increased
+    # number of `challenged` and even `authenticationFailed` outcomes, if this
+    # happens for a lot of requests.
+    # @return [String]
+    attr_accessor :collection_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['collection_reference'] = 'collectionReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        collection_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(collection_reference = SKIP)
+      @collection_reference = collection_reference unless collection_reference == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      collection_reference =
+        hash.key?('collectionReference') ? hash['collectionReference'] : SKIP
+
+      # Create object from extracted values.
+      DeviceDataRequest.new(collection_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} collection_reference: #{@collection_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} collection_reference: #{@collection_reference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/device_data_required_action_list.rb

@@ -0,0 +1,66 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # DeviceDataRequiredActionList Model.
+  class DeviceDataRequiredActionList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Supply the 3DS device data collectionReference (SessionId) to continue the
+    # payment. See [details](../3ds-actions/supply3dsdevicedata) including what
+    # to add in the request body.
+    # @return [PaymentsActionSupply3dsDeviceData]
+    attr_accessor :supply3ds_device_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['supply3ds_device_data'] = 'supply3dsDeviceData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        supply3ds_device_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(supply3ds_device_data = SKIP)
+      @supply3ds_device_data = supply3ds_device_data unless supply3ds_device_data == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      if hash['supply3dsDeviceData']
+        supply3ds_device_data = PaymentsActionSupply3dsDeviceData.from_hash(hash['supply3dsDeviceData'])
+      end
+
+      # Create object from extracted values.
+      DeviceDataRequiredActionList.new(supply3ds_device_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} supply3ds_device_data: #{@supply3ds_device_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} supply3ds_device_data: #{@supply3ds_device_data.inspect}>"
+    end
+  end
+end

data/lib/payments/models/device_data_required_response.rb

@@ -0,0 +1,89 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_response202'
+
+module Payments
+  # DeviceDataRequiredResponse Model.
+  class DeviceDataRequiredResponse < PaymentsResponse202
+    # TODO: Write general description for this method
+    # @return [DeviceDataCollection]
+    attr_accessor :device_data_collection
+
+    # TODO: Write general description for this method
+    # @return [DeviceDataRequiredActionList]
+    attr_accessor :actions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_data_collection'] = 'deviceDataCollection'
+      @_hash['actions'] = '_actions'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        device_data_collection
+        actions
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(device_data_collection = SKIP, actions = SKIP,
+                   outcome = '3dsDeviceDataRequired',
+                   transaction_reference = SKIP)
+      @device_data_collection = device_data_collection unless device_data_collection == SKIP
+      @actions = actions unless actions == SKIP
+
+      # Call the constructor of the base class
+      super(outcome,
+            transaction_reference)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      device_data_collection = DeviceDataCollection.from_hash(hash['deviceDataCollection']) if
+        hash['deviceDataCollection']
+      actions = DeviceDataRequiredActionList.from_hash(hash['_actions']) if hash['_actions']
+      outcome = hash['outcome'] ||= '3dsDeviceDataRequired'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      DeviceDataRequiredResponse.new(device_data_collection,
+                                     actions,
+                                     outcome,
+                                     transaction_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, device_data_collection: #{@device_data_collection},"\
+      " actions: #{@actions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, device_data_collection:"\
+      " #{@device_data_collection.inspect}, actions: #{@actions.inspect}>"
+    end
+  end
+end

data/lib/payments/models/device_data_response201.rb

@@ -0,0 +1,95 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # DeviceDataResponse201 Model.
+  class DeviceDataResponse201 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :outcome
+
+    # A unique reference generated by you that is used to identify a payment
+    # throughout its lifecycle.
+    # @return [String]
+    attr_accessor :transaction_reference
+
+    # Discriminators mapping.
+    def self.discriminators
+      if @_discriminators.nil?
+        @_discriminators = {}
+        @_discriminators['authorized'] = CardAuthorizedPaymentResponse
+        @_discriminators['3dsChallenged'] = ChallengedResponse
+        @_discriminators['refused'] = PaymentRefusedResponse
+        @_discriminators['3dsUnavailable'] = PaymentsResponse
+        @_discriminators['3dsAuthenticationFailed'] = UnsuccessfulAuthenticationResponse
+        @_discriminators['sentForCancellation'] = SentForCancellationResponse
+        @_discriminators['sentForSettlement'] = SentForSettlementResponse
+      end
+      @_discriminators
+    end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['outcome'] = 'outcome'
+      @_hash['transaction_reference'] = 'transactionReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        outcome
+        transaction_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(outcome = 'DeviceDataResponse201',
+                   transaction_reference = SKIP)
+      @outcome = outcome unless outcome == SKIP
+      @transaction_reference = transaction_reference unless transaction_reference == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Delegate unboxing to another function if a discriminator
+      # value for a child class is present.
+      unboxer = discriminators[hash['outcome']]
+      return unboxer.send(:from_hash, hash) if unboxer
+
+      # Extract variables from the hash.
+      outcome = hash['outcome'] ||= 'DeviceDataResponse201'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      DeviceDataResponse201.new(outcome,
+                                transaction_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outcome: #{@outcome}, transaction_reference: #{@transaction_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outcome: #{@outcome.inspect}, transaction_reference:"\
+      " #{@transaction_reference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/embedded.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Embedded Model.
+  class Embedded < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of payments within the date range.
+    # @return [Array[Payment]]
+    attr_accessor :payments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payments'] = 'payments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payments = SKIP)
+      @payments = payments unless payments == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      payments = nil
+      unless hash['payments'].nil?
+        payments = []
+        hash['payments'].each do |structure|
+          payments << (Payment.from_hash(structure) if structure)
+        end
+      end
+
+      payments = SKIP unless hash.key?('payments')
+
+      # Create object from extracted values.
+      Embedded.new(payments)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payments: #{@payments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payments: #{@payments.inspect}>"
+    end
+  end
+end